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.

Nictiz profile: RelatedPerson

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug

Body


resourceType*			This is a RelatedPerson resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The 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.
implicitRules	uri		A 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.
language	code		The base language in which the resource is written.
text	Narrative		A 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.
contained	array(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.
extension	array(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.
modifierExtension	array(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).
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	array(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		male\|female\|other\|unknown	Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
birthDate	date		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 during which this relationship is or was active. If there are no dates defined, then the interval is unknown.
communication	array(RelatedPerson_Communication)		A language which may be used to communicate with about the patient's health.

Response

201 400 401 404

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.

Nictiz profile: RelatedPerson

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*			This is a RelatedPerson resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The 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.
implicitRules	uri		A 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.
language	code		The base language in which the resource is written.
text	Narrative		A 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.
contained	array(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.
extension	array(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.
modifierExtension	array(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).
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	array(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		male\|female\|other\|unknown	Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
birthDate	date		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 during which this relationship is or was active. If there are no dates defined, then the interval is unknown.
communication	array(RelatedPerson_Communication)		A language which may be used to communicate with about the patient's health.

Response

200 201 400 401 404 409

Read Related Person

get

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

Nictiz profile: RelatedPerson

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read History Related Person

get

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

Nictiz profile: RelatedPerson

Request

Headers


content-type*	string	application/json\|application/json+fhir	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

200 401 404

Read Version Related Person

get

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

Nictiz profile: RelatedPerson

Request

Headers


content-type*	string	application/json\|application/json+fhir	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

200 400 401 404

Remove Related Person

delete

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

Nictiz profile: RelatedPerson

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 204 400 401 404 409

Search Get Related Person

get

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

Nictiz profile: RelatedPerson

Request

Headers


content-type*	string	application/json\|application/json+fhir	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
email	string
gender	string
identifier	string
name	string
patient	string
phone	string
phonetic	string
relationship	string
telecom	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Related Person

get

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

Nictiz profile: RelatedPerson

Request

Headers


content-type*	string	application/json\|application/json+fhir	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

200 401 404

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.

Nictiz profile: RelatedPerson

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
email	string
gender	string
identifier	string
name	string
patient	string
phone	string
phonetic	string
relationship	string
telecom	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*			This is a RelatedPerson resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The 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.
implicitRules	uri		A 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.
language	code		The base language in which the resource is written.
text	Narrative		A 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.
contained	array(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.
extension	array(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.
modifierExtension	array(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).
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	array(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		male\|female\|other\|unknown	Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
birthDate	date		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 during which this relationship is or was active. If there are no dates defined, then the interval is unknown.
communication	array(RelatedPerson_Communication)		A language which may be used to communicate with about the patient's health.

Response

200 401 404

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.

Nictiz profile: RelatedPerson

Request

Headers


content-type*	string	application/json\|application/json+fhir	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*			This is a RelatedPerson resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The 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.
implicitRules	uri		A 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.
language	code		The base language in which the resource is written.
text	Narrative		A 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.
contained	array(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.
extension	array(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.
modifierExtension	array(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).
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	array(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		male\|female\|other\|unknown	Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
birthDate	date		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 during which this relationship is or was active. If there are no dates defined, then the interval is unknown.
communication	array(RelatedPerson_Communication)		A language which may be used to communicate with about the patient's health.

Response

200 201 400 401 404 409