RelatedPerson - FHIR Resource (stu3)


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

Validate an RelatedPerson FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
activefalseboolean Whether this related person's record is in active use
addresstrueAddress Address where the related person can be contacted or visited
birthDatefalsedate The date on which the related person was born
genderfalsecode male | female | other | unknown
identifiertrueIdentifier A human identifier for this person
nametrueHumanName A name associated with the person
patientfalseReference The patient this person is related to
periodfalsePeriod Period of time that this relationship is considered valid
phototrueAttachment Image of the person
relationshipfalseCodeableConcept The nature of the relationship
telecomtrueContactPoint A contact detail for the person

RelatedPerson Example

{
  "patient": {
    "reference": "Patient/example"
  },
  "name": [
    {
      "given": [
        "Bénédicte"
      ],
      "_family": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix",
            "valueString": "VV"
          }
        ]
      },
      "family": "du Marché"
    }
  ],
  "relationship": {
    "coding": [
      {
        "code": "N",
        "system": "http://hl7.org/fhir/v2/0131"
      },
      {
        "code": "WIFE",
        "system": "http://hl7.org/fhir/v3/RoleCode"
      }
    ]
  },
  "resourceType": "RelatedPerson",
  "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>"
  },
  "address": [
    {
      "postalCode": "75004",
      "city": "Paris",
      "line": [
        "43, Place du Marché Sainte Catherine"
      ],
      "country": "FRA"
    }
  ],
  "telecom": [
    {
      "system": "phone",
      "value": "+33 (237) 998327"
    }
  ],
  "gender": "female",
  "active": true,
  "identifier": [
    {
      "use": "usual",
      "type": {
        "text": "INSEE"
      },
      "system": "urn:oid:1.2.250.1.61",
      "value": "272117510400399"
    }
  ],
  "id": "benedicte",
  "photo": [
    {
      "url": "Binary/f016",
      "contentType": "image/jpeg"
    }
  ]
}

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
}


 

RelatedPerson Search Parameters

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

https://api.1up.health/fhir/stu3/RelatedPerson?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
activetextactive
addresstextaddress.line, address.city, address.state, address.country, address.postalCode, address.text
address-citytextaddress.city
address-countrytextaddress.country
address-postalcodetextaddress.postalCode
address-statetextaddress.state
address-usetextaddress.use
birthdatedatebirthDate
emailtexttelecom.where
gendertextgender
identifiertextidentifier
nametextname.family, name.give, name.prefix, name.suffix, name.suffix, name.text
patientreferencepatient
phonetexttelecom.where
phonetictextname
telecomtexttelecom