Patient - FHIR Resource (stu3)


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

Resource Attributes

AttributeField is listTypeDescription
activefalseboolean Whether this patient's record is in active use
addresstrueAddress Addresses for the individual
animalfalseData Type This patient is known to be an animal (non-human)
birthDatefalsedate The date of birth for the individual
communicationtrueData Type A list of Languages which may be used to communicate with the patient about his or her health
contacttrueData Type A contact party (e.g. guardian, partner, friend) for the patient
deceasedBooleanfalseboolean "deceasedBoolean" : <boolean>,
deceasedDateTimefalsedateTime "deceasedDateTime" : "<dateTime>",
genderfalsecode male | female | other | unknown
generalPractitionertrueReference Patient's nominated primary care provider
identifiertrueIdentifier An identifier for this patient
linktrueData Type Link to another patient resource that concerns the same actual person
managingOrganizationfalseReference Organization that is the custodian of the patient record
maritalStatusfalseCodeableConcept Marital (civil) status of a patient
multipleBirthBooleanfalseboolean "multipleBirthBoolean" : <boolean>,
multipleBirthIntegerfalseinteger "multipleBirthInteger" : <integer>,
nametrueHumanName A name associated with the patient
phototrueAttachment Image of the patient
telecomtrueContactPoint A contact detail for the individual

Patient Example

{
  "managingOrganization": {
    "reference": "Organization/1"
  },
  "name": [
    {
      "use": "official",
      "given": [
        "Peter",
        "James"
      ],
      "family": "Chalmers"
    },
    {
      "use": "usual",
      "given": [
        "Jim"
      ]
    },
    {
      "use": "maiden",
      "given": [
        "Peter",
        "James"
      ],
      "family": "Windsor",
      "period": {
        "end": "2002"
      }
    }
  ],
  "deceasedBoolean": false,
  "resourceType": "Patient",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\t\t\t<table>\n\t\t\t\t<tbody>\n\t\t\t\t\t<tr>\n\t\t\t\t\t\t<td>Name</td>\n\t\t\t\t\t\t<td>Peter James \n              <b>Chalmers</b> (&quot;Jim&quot;)\n            </td>\n\t\t\t\t\t</tr>\n\t\t\t\t\t<tr>\n\t\t\t\t\t\t<td>Address</td>\n\t\t\t\t\t\t<td>534 Erewhon, Pleasantville, Vic, 3999</td>\n\t\t\t\t\t</tr>\n\t\t\t\t\t<tr>\n\t\t\t\t\t\t<td>Contacts</td>\n\t\t\t\t\t\t<td>Home: unknown. Work: (03) 5555 6473</td>\n\t\t\t\t\t</tr>\n\t\t\t\t\t<tr>\n\t\t\t\t\t\t<td>Id</td>\n\t\t\t\t\t\t<td>MRN: 12345 (Acme Healthcare)</td>\n\t\t\t\t\t</tr>\n\t\t\t\t</tbody>\n\t\t\t</table>\n\t\t</div>"
  },
  "address": [
    {
      "city": "PleasantVille",
      "use": "home",
      "district": "Rainbow",
      "text": "534 Erewhon St PeasantVille, Rainbow, Vic  3999",
      "period": {
        "start": "1974-12-25"
      },
      "state": "Vic",
      "postalCode": "3999",
      "line": [
        "534 Erewhon St"
      ],
      "type": "both"
    }
  ],
  "birthDate": "1974-12-25",
  "telecom": [
    {
      "use": "home"
    },
    {
      "use": "work",
      "rank": 1,
      "system": "phone",
      "value": "(03) 5555 6473"
    },
    {
      "use": "mobile",
      "rank": 2,
      "system": "phone",
      "value": "(03) 3410 5613"
    },
    {
      "use": "old",
      "system": "phone",
      "value": "(03) 5555 8834",
      "period": {
        "end": "2014"
      }
    }
  ],
  "contact": [
    {
      "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"
            }
          ]
        }
      ],
      "telecom": [
        {
          "system": "phone",
          "value": "+33 (237) 998327"
        }
      ],
      "gender": "female",
      "period": {
        "start": "2012"
      },
      "address": {
        "city": "PleasantVille",
        "use": "home",
        "district": "Rainbow",
        "period": {
          "start": "1974-12-25"
        },
        "state": "Vic",
        "postalCode": "3999",
        "line": [
          "534 Erewhon St"
        ],
        "type": "both"
      }
    }
  ],
  "gender": "male",
  "active": true,
  "identifier": [
    {
      "use": "usual",
      "assigner": {
        "display": "Acme Healthcare"
      },
      "system": "urn:oid:1.2.36.146.595.217.0.1",
      "value": "12345",
      "period": {
        "start": "2001-05-06"
      },
      "type": {
        "coding": [
          {
            "code": "MR",
            "system": "http://hl7.org/fhir/v2/0203"
          }
        ]
      }
    }
  ],
  "_birthDate": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/StructureDefinition/patient-birthTime",
        "valueDateTime": "1974-12-25T14:35:45-05:00"
      }
    ]
  },
  "id": "example"
}

Patient Structure


  
{
  "resourceType" : "Patient",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // An identifier for this patient
  "active" : <boolean>, // Whether this patient's record is in active use
  "name" : [{ HumanName }], // A name associated with the patient
  "telecom" : [{ ContactPoint }], // A contact detail for the individual
  "gender" : "<code>", // male | female | other | unknown
  "birthDate" : "<date>", // The date of birth for the individual
  // deceased[x]: Indicates if the individual is deceased or not. One of these 2:
  "deceasedBoolean" : <boolean>,
  "deceasedDateTime" : "<dateTime>",
  "address" : [{ Address }], // Addresses for the individual
  "maritalStatus" : { CodeableConcept }, // Marital (civil) status of a patient
  // multipleBirth[x]: Whether patient is part of a multiple birth. One of these 2:
  "multipleBirthBoolean" : <boolean>,
  "multipleBirthInteger" : <integer>,
  "photo" : [{ Attachment }], // Image of the patient
  "contact" : [{ // A contact party (e.g. guardian, partner, friend) for the patient
    "relationship" : [{ CodeableConcept }], // The kind of relationship
    "name" : { HumanName }, // A name associated with the contact person
    "telecom" : [{ ContactPoint }], // A contact detail for the person
    "address" : { Address }, // Address for the contact person
    "gender" : "<code>", // male | female | other | unknown
    "organization" : { Reference(Organization) }, // C? Organization that is associated with the contact
    "period" : { Period } // The period during which this contact person or organization is valid to be contacted relating to this patient
  }],
  "animal" : { // This patient is known to be an animal (non-human)
    "species" : { CodeableConcept }, // R!  E.g. Dog, Cow
    "breed" : { CodeableConcept }, // E.g. Poodle, Angus
    "genderStatus" : { CodeableConcept } // E.g. Neutered, Intact
  },
  "communication" : [{ // A list of Languages which may be used to communicate with the patient about his or her 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
  }],
  "generalPractitioner" : [{ Reference(Organization|Practitioner) }], // Patient's nominated primary care provider
  "managingOrganization" : { Reference(Organization) }, // Organization that is the custodian of the patient record
  "link" : [{ // Link to another patient resource that concerns the same actual person
    "other" : { Reference(Patient|RelatedPerson) }, // R!  The other patient or related person resource that the link refers to
    "type" : "<code>" // R!  replaced-by | replaces | refer | seealso - type of link
  }]
}


 

Patient Search Parameters

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

https://api.1up.health/fhir/stu3/Patient?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
animal-breedtextanimal.breed
animal-speciestextanimal.species
birthdatedatebirthDate
death-datedatedeceased.as
deceasedtextdeceased.exists
emailtexttelecom.where
familytextname.family
gendertextgender
general-practitionerreferencegeneralPractitioner
giventextname.given
identifiertextidentifier
languagetextcommunication.language
linkreferencelink.other
nametextname.family, name.give, name.prefix, name.suffix, name.suffix, name.text
organizationreferencemanagingOrganization
phonetexttelecom.where
phonetictextname
telecomtexttelecom