RelatedPerson - FHIR Resource (r4)

This RelatedPerson Resource uses the FHIR API standard for access and structure.

Validate an RelatedPerson FHIR Resource (r4)

Validate this RelatedPerson

Resource Attributes

Attribute	Field is list	Type	Description
active	false	boolean	# Whether this related person's record is in active use
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
communication	true	Data Type	# A language which may be used to communicate with about the patient's health
gender	false	code	# male | female | other | unknown
identifier	true	Identifier	# A human identifier for this person
name	true	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	true	CodeableConcept	# The nature of the relationship
telecom	true	ContactPoint	# A contact detail for the person

RelatedPerson Example

{
  "resourceType": "RelatedPerson",
  "id": "benedicte",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <table>\n        <tbody>\n          <tr>\n            <td>Name</td>\n            <td>Bénédicte du Marché</td>\n          </tr>\n          <tr>\n            <td>Address</td>\n            <td>43, Place du Marché Sainte Catherine, 75004 Paris, France</td>\n          </tr>\n          <tr>\n            <td>Contacts</td>\n            <td>Phone: +33 (237) 998327</td>\n          </tr>\n        </tbody>\n      </table>\n    </div>"
  },
  "identifier": [
    {
      "use": "usual",
      "type": {
        "text": "INSEE"
      },
      "system": "urn:oid:1.2.250.1.61",
      "value": "272117510400399"
    }
  ],
  "active": true,
  "patient": {
    "reference": "Patient/example"
  },
  "relationship": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v2-0131",
          "code": "N"
        },
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
          "code": "WIFE"
        }
      ]
    }
  ],
  "name": [
    {
      "family": "du Marché",
      "_family": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix",
            "valueString": "VV"
          }
        ]
      },
      "given": [
        "Bénédicte"
      ]
    }
  ],
  "telecom": [
    {
      "system": "phone",
      "value": "+33 (237) 998327"
    }
  ],
  "gender": "female",
  "address": [
    {
      "line": [
        "43, Place du Marché Sainte Catherine"
      ],
      "city": "Paris",
      "postalCode": "75004",
      "country": "FRA"
    }
  ],
  "photo": [
    {
      "contentType": "image/jpeg",
      "url": "Binary/f016"
    }
  ]
}

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
  "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
  "communication" : [{ // A language which may be used to communicate with about the patient's health
    "language" : { CodeableConcept }, // R!  The language which can be used to communicate with the patient about his or her health
    "preferred" : <boolean> // Language preference indicator
  }]
}

RelatedPerson Search Parameters

The following search parameters can be used to query RelatedPerson resources. Just submit them like so:

https://api.1up.health/fhir/r4/RelatedPerson?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
active	text	active
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.where
gender	text	gender
identifier	text	identifier
name	text	name
patient	reference	patient
phone	text	telecom.where
phonetic	text	name
relationship	text	relationship
telecom	text	telecom