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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringRelatedPersonThis is a RelatedPerson resource
identifierarray(Identifier)Identifier for a person within a particular scope.
activebooleanWhether this related person record is in active use.
patient*ReferenceThe patient this person is related to.
relationshipCodeableConceptThe nature of the relationship between a patient and the related person.
namearray(HumanName)A name associated with the person.
telecomarray(ContactPoint)A contact detail for the person, e.g. a telephone number or an email address.
genderstringmale|female|other|unknownAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
birthDatestringThe date on which the related person was born.
addressarray(Address)Address where the related person can be contacted or visited.
photoarray(Attachment)Image of the person.
periodPeriodThe period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown.

Response

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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringRelatedPersonThis is a RelatedPerson resource
identifierarray(Identifier)Identifier for a person within a particular scope.
activebooleanWhether this related person record is in active use.
patient*ReferenceThe patient this person is related to.
relationshipCodeableConceptThe nature of the relationship between a patient and the related person.
namearray(HumanName)A name associated with the person.
telecomarray(ContactPoint)A contact detail for the person, e.g. a telephone number or an email address.
genderstringmale|female|other|unknownAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
birthDatestringThe date on which the related person was born.
addressarray(Address)Address where the related person can be contacted or visited.
photoarray(Attachment)Image of the person.
periodPeriodThe period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown.

Response

Read Related Person

get
/organizations/{organizationId}/fhir/3/RelatedPerson/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Related Person

get
/organizations/{organizationId}/fhir/3/RelatedPerson/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Related Person

get
/organizations/{organizationId}/fhir/3/RelatedPerson/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Related Person

delete
/organizations/{organizationId}/fhir/3/RelatedPerson/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Related Person

get
/organizations/{organizationId}/fhir/3/RelatedPerson

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
activestring
addressstring
address-citystring
address-countrystring
address-postalcodestring
address-statestring
address-usestring
birthdatestring
emailstring
genderstring
identifierstring
namestring
patientstring
phonestring
phoneticstring
telecomstring

Params

organizationId*string|stringid|slug

Response

Search History Related Person

get
/organizations/{organizationId}/fhir/3/RelatedPerson/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
activestring
addressstring
address-citystring
address-countrystring
address-postalcodestring
address-statestring
address-usestring
birthdatestring
emailstring
genderstring
identifierstring
namestring
patientstring
phonestring
phoneticstring
telecomstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringRelatedPersonThis is a RelatedPerson resource
identifierarray(Identifier)Identifier for a person within a particular scope.
activebooleanWhether this related person record is in active use.
patient*ReferenceThe patient this person is related to.
relationshipCodeableConceptThe nature of the relationship between a patient and the related person.
namearray(HumanName)A name associated with the person.
telecomarray(ContactPoint)A contact detail for the person, e.g. a telephone number or an email address.
genderstringmale|female|other|unknownAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
birthDatestringThe date on which the related person was born.
addressarray(Address)Address where the related person can be contacted or visited.
photoarray(Attachment)Image of the person.
periodPeriodThe period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown.

Response

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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringRelatedPersonThis is a RelatedPerson resource
identifierarray(Identifier)Identifier for a person within a particular scope.
activebooleanWhether this related person record is in active use.
patient*ReferenceThe patient this person is related to.
relationshipCodeableConceptThe nature of the relationship between a patient and the related person.
namearray(HumanName)A name associated with the person.
telecomarray(ContactPoint)A contact detail for the person, e.g. a telephone number or an email address.
genderstringmale|female|other|unknownAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
birthDatestringThe date on which the related person was born.
addressarray(Address)Address where the related person can be contacted or visited.
photoarray(Attachment)Image of the person.
periodPeriodThe period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown.

Response