related persons
Create Related Person
post
/organizations/{organizationId}/fhir/3/RelatedPerson
Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.
Request
Headers
content-type* | string | application/json | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | string | RelatedPerson | This is a RelatedPerson resource |
identifier | array(Identifier) | Identifier for a person within a particular scope. | |
active | boolean | Whether this related person record is in active use. | |
patient* | Reference | The patient this person is related to. | |
relationship | CodeableConcept | The nature of the relationship between a patient and the related person. | |
name | array(HumanName) | A name associated with the person. | |
telecom | array(ContactPoint) | A contact detail for the person, e.g. a telephone number or an email address. | |
gender | string | male|female|other|unknown | Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. |
birthDate | string | The date on which the related person was born. | |
address | array(Address) | Address where the related person can be contacted or visited. | |
photo | array(Attachment) | Image of the person. | |
period | Period | The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown. |
Response
keyboard_arrow_down
Patch Related Person
patch
/organizations/{organizationId}/fhir/3/RelatedPerson/{resourceId}
Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.
Request
Headers
content-type* | string | application/json-patch+json | application/json-patch+json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Body
resourceType* | string | RelatedPerson | This is a RelatedPerson resource |
identifier | array(Identifier) | Identifier for a person within a particular scope. | |
active | boolean | Whether this related person record is in active use. | |
patient* | Reference | The patient this person is related to. | |
relationship | CodeableConcept | The nature of the relationship between a patient and the related person. | |
name | array(HumanName) | A name associated with the person. | |
telecom | array(ContactPoint) | A contact detail for the person, e.g. a telephone number or an email address. | |
gender | string | male|female|other|unknown | Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. |
birthDate | string | The date on which the related person was born. | |
address | array(Address) | Address where the related person can be contacted or visited. | |
photo | array(Attachment) | Image of the person. | |
period | Period | The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown. |
Response
keyboard_arrow_down
Read Related Person
get
/organizations/{organizationId}/fhir/3/RelatedPerson/{resourceId}
Request
Headers
content-type* | string | application/json | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Response
keyboard_arrow_down
Read History Related Person
get
/organizations/{organizationId}/fhir/3/RelatedPerson/{resourceId}/_history
Request
Headers
content-type* | string | application/json | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Query params
_count | string | ||
_since | string |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Response
keyboard_arrow_down
Read Version Related Person
get
/organizations/{organizationId}/fhir/3/RelatedPerson/{resourceId}/_history/{versionId}
Request
Headers
content-type* | string | application/json | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* | |||
versionId* |
Response
keyboard_arrow_down
Remove Related Person
delete
/organizations/{organizationId}/fhir/3/RelatedPerson/{resourceId}
Request
Headers
content-type* | string | application/json | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Response
keyboard_arrow_down
Search Get Related Person
get
/organizations/{organizationId}/fhir/3/RelatedPerson
Request
Headers
content-type* | string | application/json | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Query params
_id | string | ||
_language | string | ||
active | string | ||
address | string | ||
address-city | string | ||
address-country | string | ||
address-postalcode | string | ||
address-state | string | ||
address-use | string | ||
birthdate | string | ||
string | |||
gender | string | ||
identifier | string | ||
name | string | ||
patient | string | ||
phone | string | ||
phonetic | string | ||
telecom | string |
Params
organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Related Person
get
/organizations/{organizationId}/fhir/3/RelatedPerson/_history
Request
Headers
content-type* | string | application/json | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Query params
_count | string | ||
_since | string |
Params
organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search Post Related Person
post
/organizations/{organizationId}/fhir/3/RelatedPerson/_search
Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.
Request
Headers
content-type* | string | application/json|application/x-www-form-urlencoded | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Query params
_id | string | ||
_language | string | ||
active | string | ||
address | string | ||
address-city | string | ||
address-country | string | ||
address-postalcode | string | ||
address-state | string | ||
address-use | string | ||
birthdate | string | ||
string | |||
gender | string | ||
identifier | string | ||
name | string | ||
patient | string | ||
phone | string | ||
phonetic | string | ||
telecom | string |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | string | RelatedPerson | This is a RelatedPerson resource |
identifier | array(Identifier) | Identifier for a person within a particular scope. | |
active | boolean | Whether this related person record is in active use. | |
patient* | Reference | The patient this person is related to. | |
relationship | CodeableConcept | The nature of the relationship between a patient and the related person. | |
name | array(HumanName) | A name associated with the person. | |
telecom | array(ContactPoint) | A contact detail for the person, e.g. a telephone number or an email address. | |
gender | string | male|female|other|unknown | Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. |
birthDate | string | The date on which the related person was born. | |
address | array(Address) | Address where the related person can be contacted or visited. | |
photo | array(Attachment) | Image of the person. | |
period | Period | The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown. |
Response
keyboard_arrow_down
Update Related Person
put
/organizations/{organizationId}/fhir/3/RelatedPerson/{resourceId}
Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.
Request
Headers
content-type* | string | application/json | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Body
resourceType* | string | RelatedPerson | This is a RelatedPerson resource |
identifier | array(Identifier) | Identifier for a person within a particular scope. | |
active | boolean | Whether this related person record is in active use. | |
patient* | Reference | The patient this person is related to. | |
relationship | CodeableConcept | The nature of the relationship between a patient and the related person. | |
name | array(HumanName) | A name associated with the person. | |
telecom | array(ContactPoint) | A contact detail for the person, e.g. a telephone number or an email address. | |
gender | string | male|female|other|unknown | Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. |
birthDate | string | The date on which the related person was born. | |
address | array(Address) | Address where the related person can be contacted or visited. | |
photo | array(Attachment) | Image of the person. | |
period | Period | The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown. |
Response
keyboard_arrow_down