Person - FHIR Resource (r4)


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

Validate an Person FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
activefalseboolean# This person's record is in active use
addresstrueAddress# One or more addresses for the person
birthDatefalsedate# The date on which the person was born
genderfalsecode# male | female | other | unknown
identifiertrueIdentifier# A human identifier for this person
linktrueData Type# Link to a resource that concerns the same actual person
managingOrganizationfalseReference# The organization that is the custodian of the person record
nametrueHumanName# A name associated with the person
photofalseAttachment# Image of the person
telecomtrueContactPoint# A contact detail for the person

Person Example

{
  "resourceType": "Person",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <table>\n        <tbody>\n          <tr>\n            <td>Name</td>\n            <td>Peter James <b>Chalmers</b> (&quot;Jim&quot;)</td>\n          </tr>\n          <tr>\n            <td>Address</td>\n            <td>534 Erewhon, Pleasantville, Vic, 3999</td>\n          </tr>\n          <tr>\n            <td>Contacts</td>\n            <td>Home: unknown. Work: (03) 5555 6473</td>\n          </tr>\n          <tr>\n            <td>Id</td>\n            <td>MRN: 12345 (Acme Healthcare)</td>\n          </tr>\n        </tbody>\n      </table>\n    </div>"
  },
  "identifier": [
    {
      "use": "usual",
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
            "code": "MR"
          }
        ]
      },
      "system": "urn:oid:1.2.36.146.595.217.0.1",
      "value": "12345",
      "period": {
        "start": "2001-05-06"
      },
      "assigner": {
        "display": "Acme Healthcare"
      }
    }
  ],
  "name": [
    {
      "use": "official",
      "family": "Chalmers",
      "given": [
        "Peter",
        "James"
      ]
    },
    {
      "use": "usual",
      "given": [
        "Jim"
      ]
    }
  ],
  "telecom": [
    {
      "use": "home"
    },
    {
      "system": "phone",
      "value": "(03) 5555 6473",
      "use": "work"
    },
    {
      "system": "email",
      "value": "Jim@example.org",
      "use": "home"
    }
  ],
  "gender": "male",
  "birthDate": "1974-12-25",
  "address": [
    {
      "use": "home",
      "line": [
        "534 Erewhon St"
      ],
      "city": "PleasantVille",
      "state": "Vic",
      "postalCode": "3999"
    }
  ],
  "active": true,
  "link": [
    {
      "target": {
        "reference": "RelatedPerson/peter",
        "display": "Peter Chalmers"
      }
    },
    {
      "target": {
        "reference": "Patient/example",
        "display": "Peter Chalmers"
      }
    }
  ]
}

Person Structure

{
  "resourceType" : "Person",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // A human identifier for this person
  "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 person was born
  "address" : [{ Address }], // One or more addresses for the person
  "photo" : { Attachment }, // Image of the person
  "managingOrganization" : { Reference(Organization) }, // The organization that is the custodian of the person record
  "active" : <boolean>, // This person's record is in active use
  "link" : [{ // Link to a resource that concerns the same actual person
    "target" : { Reference(Patient|Practitioner|RelatedPerson|Person) }, // R!  The resource to which this actual person is associated
    "assurance" : "<code>" // level1 | level2 | level3 | level4
  }]
}

Person Search Parameters

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

https://api.1up.health/fhir/r4/Person?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
addresstextaddress
address-citytextaddress.city
address-countrytextaddress.country
address-postalcodetextaddress.postalCode
address-statetextaddress.state
address-usetextaddress.use
birthdatedatebirthDate
emailtexttelecom.where
gendertextgender
identifiertextidentifier
linkreferencelink.target
nametextname
organizationreferencemanagingOrganization
patientreferencelink.target.where
phonetexttelecom.where
phonetictextname
practitionerreferencelink.target.where
relatedpersonreferencelink.target.where
telecomtexttelecom