related persons

Create Related Person

post
/organizations/{organizationId}/fhir/4/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/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*This is a RelatedPerson resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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.
relationshiparray(CodeableConcept)The 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.
gendermale|female|other|unknownAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
birthDatedateThe 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 during which this relationship is or was active. If there are no dates defined, then the interval is unknown.
communicationarray(RelatedPerson_Communication)A language which may be used to communicate with about the patient's health.

Response

Patch Related Person

patch
/organizations/{organizationId}/fhir/4/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*This is a RelatedPerson resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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.
relationshiparray(CodeableConcept)The 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.
gendermale|female|other|unknownAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
birthDatedateThe 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 during which this relationship is or was active. If there are no dates defined, then the interval is unknown.
communicationarray(RelatedPerson_Communication)A language which may be used to communicate with about the patient's health.

Response

Read Related Person

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Related Person

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/RelatedPerson/{resourceId}/_history/{versionId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Related Person

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Related Person

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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
relationshipstring
telecomstring

Params

organizationId*string|stringid|slug

Response

Search History Related Person

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/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
relationshipstring
telecomstring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a RelatedPerson resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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.
relationshiparray(CodeableConcept)The 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.
gendermale|female|other|unknownAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
birthDatedateThe 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 during which this relationship is or was active. If there are no dates defined, then the interval is unknown.
communicationarray(RelatedPerson_Communication)A language which may be used to communicate with about the patient's health.

Response

Update Related Person

put
/organizations/{organizationId}/fhir/4/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|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a RelatedPerson resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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.
relationshiparray(CodeableConcept)The 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.
gendermale|female|other|unknownAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
birthDatedateThe 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 during which this relationship is or was active. If there are no dates defined, then the interval is unknown.
communicationarray(RelatedPerson_Communication)A language which may be used to communicate with about the patient's health.

Response