Patient - FHIR Resource (dstu2)


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

Validate an Patient FHIR Resource (dstu2)



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
careProvidertrueReference# Patient's nominated primary care provider
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
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 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
  }],
  "careProvider" : [{ 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) }, // R!  The other patient resource that the link refers to
    "type" : "<code>" // R!  replace | 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/dstu2/Patient?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
activetextactive
addresstextaddress
address-citytextaddress.city
address-countrytextaddress.country
address-postalcodetextaddress.postalCode
address-statetextaddress.state
address-usetextaddress.use
animal-breedtextanimal.breed
animal-speciestextanimal.species
birthdatedatebirthDate
careproviderreferencecareProvider
deathdatedatedeceasedDateTime
deceasedtextdeceased[x]
emailtexttelecom
familytextname.family
gendertextgender
giventextname.given
identifiertextidentifier
languagetextcommunication.language
linkreferencelink.other
nametextname
organizationreferencemanagingOrganization
phonetexttelecom
phonetictextname
telecomtexttelecom