GET fhir/v1/{clientId}/{vendor}/{vendorversion}/relatedperson/{id}
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 Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
clientId | string |
Required |
|
vendor | EHRVendor |
Required |
|
vendorversion | string |
Required |
|
id | string |
Required |
Body Parameters
None.
Response Information
Resource Description
RelatedPersonNone.
Response Formats
application/json, text/json
Sample:
{ "resourceType" : "RelatedPerson", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // A human identifier for this person "active" : <boolean>, // Whether this related person's record is in active use "patient" : { Reference(Patient) }, // R! The patient this person is related to "relationship" : { CodeableConcept }, // The nature of the relationship "name" : [{ HumanName }], // A name associated with the person "telecom" : [{ ContactPoint }], // A contact detail for the person "gender" : "<code>", // male | female | other | unknown "birthDate" : "<date>", // The date on which the related person was born "address" : [{ Address }], // Address where the related person can be contacted or visited "photo" : [{ Attachment }], // Image of the person "period" : { Period } // Period of time that this relationship is considered valid }
application/xml, text/xml
Sample:
<RelatedPerson xmlns="http://hl7.org/fhir"> doco <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier A human identifier for this person --></identifier> <active value="[boolean]"/><!-- 0..1 Whether this related person's record is in active use --> <patient><!-- 1..1 Reference(Patient) The patient this person is related to --></patient> <relationship><!-- 0..1 CodeableConcept The nature of the relationship --></relationship> <name><!-- 0..* HumanName A name associated with the person --></name> <telecom><!-- 0..* ContactPoint A contact detail for the person --></telecom> <gender value="[code]"/><!-- 0..1 male | female | other | unknown --> <birthDate value="[date]"/><!-- 0..1 The date on which the related person was born --> <address><!-- 0..* Address Address where the related person can be contacted or visited --></address> <photo><!-- 0..* Attachment Image of the person --></photo> <period><!-- 0..1 Period Period of time that this relationship is considered valid --></period> </RelatedPerson>