RelatedPerson_GET

GET {{baseUrl}}/RelatedPerson?patient=<string>&_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>&birthdate=<date>&email=<string>&gender=<string>&phone=<string>&phonetic=<string>&telecom=<string>&active=<string>&identifier=<string>&name=<string>&_format=<string>

Request Params

• 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 | | 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 | | 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 | | 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 | | 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 | | Indicates if the related person record is active | | identifier | string | | An Identifier of the RelatedPerson | | 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"},"patient":{"reference":"\u003cstring\u003e"},"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"}}]},"name":{"use":"\u003cstring\u003e","family":["\u003cobject\u003e","\u003cobject\u003e"],"given":["\u003cobject\u003e","\u003cobject\u003e"]},"telecom":[{"system":"\u003cstring\u003e","value":"\u003cstring\u003e","use":"\u003cstring\u003e"}],"gender":"\u003cstring\u003e","address":[{"use":"\u003cstring\u003e","city":"\u003cstring\u003e","state":"\u003cstring\u003e","postalCode":"\u003cstring\u003e","line":["\u003cobject\u003e","\u003cobject\u003e"]}],"photo":[{"contentType":"\u003cstring\u003e","url":"\u003cstring\u003e"}],"period":{"start":"\u003cstring\u003e"}},{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","text":{"status":"\u003cstring\u003e","div":"\u003cstring\u003e"},"patient":{"reference":"\u003cstring\u003e"},"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"}}]},"name":{"use":"\u003cstring\u003e","family":["\u003cobject\u003e","\u003cobject\u003e"],"given":["\u003cobject\u003e","\u003cobject\u003e"]},"telecom":[{"system":"\u003cstring\u003e","value":"\u003cstring\u003e","use":"\u003cstring\u003e"}],"gender":"\u003cstring\u003e","address":[{"use":"\u003cstring\u003e","city":"\u003cstring\u003e","state":"\u003cstring\u003e","postalCode":"\u003cstring\u003e","line":["\u003cobject\u003e","\u003cobject\u003e"]}],"photo":[{"contentType":"\u003cstring\u003e","url":"\u003cstring\u003e"}],"period":{"start":"\u003cstring\u003e"}}]