RelatedPerson - FHIR Resource (dstu2)
This RelatedPerson Resource uses the
FHIR API standard for access and structure.
Validate an RelatedPerson FHIR Resource (dstu2)
Resource Attributes
Attribute | Field is list | Type | Description |
---|
address | true | Address | # Address where the related person can be contacted or visited
|
birthDate | false | date | # The date on which the related person was born
|
gender | false | code | # male | female | other | unknown
|
identifier | true | Identifier | # A human identifier for this person
|
name | false | HumanName | # A name associated with the person
|
patient | false | Reference | # The patient this person is related to
|
period | false | Period | # Period of time that this relationship is considered valid
|
photo | true | Attachment | # Image of the person
|
relationship | false | CodeableConcept | # The nature of the relationship
|
telecom | true | ContactPoint | # A contact detail for the person
|
RelatedPerson Structure
{
"resourceType" : "RelatedPerson",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // A human identifier for this person
"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
}
RelatedPerson Search Parameters
The following search parameters can be used to query RelatedPerson resources. Just submit them like so:
https://api.1up.health/fhir/dstu2/RelatedPerson?query-param=queryvalue
Search Parameter | Field Type | Resource Fields Searched |
---|
address | text | address |
address-city | text | address.city |
address-country | text | address.country |
address-postalcode | text | address.postalCode |
address-state | text | address.state |
address-use | text | address.use |
birthdate | date | birthDate |
email | text | telecom.value, telecom.system |
gender | text | gender |
identifier | text | identifier |
name | text | name |
patient | reference | patient |
phone | text | telecom.value, telecom.system |
phonetic | text | name |
telecom | text | telecom.value, telecom.system |