Patient - FHIR Resource (dstu2)

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

Validate an Patient FHIR Resource (dstu2)

Validate this Patient

Resource Attributes

Attribute	Field is list	Type	Description
active	false	boolean	# Whether this patient's record is in active use
address	true	Address	# Addresses for the individual
animal	false	Data Type	# This patient is known to be an animal (non-human)
birthDate	false	date	# The date of birth for the individual
careProvider	true	Reference	# Patient's nominated primary care provider
communication	true	Data Type	# A list of Languages which may be used to communicate with the patient about his or her health
contact	true	Data Type	# A contact party (e.g. guardian, partner, friend) for the patient
deceasedBoolean	false	boolean	# "deceasedBoolean" : <boolean>,
deceasedDateTime	false	dateTime	# "deceasedDateTime" : "<dateTime>",
gender	false	code	# male | female | other | unknown
identifier	true	Identifier	# An identifier for this patient
link	true	Data Type	# Link to another patient resource that concerns the same actual person
managingOrganization	false	Reference	# Organization that is the custodian of the patient record
maritalStatus	false	CodeableConcept	# Marital (civil) status of a patient
multipleBirthBoolean	false	boolean	# "multipleBirthBoolean" : <boolean>,
multipleBirthInteger	false	integer	# "multipleBirthInteger" : <integer>,
name	true	HumanName	# A name associated with the patient
photo	true	Attachment	# Image of the patient
telecom	true	ContactPoint	# 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 them like so:

https://api.1up.health/fhir/dstu2/Patient?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
animal-breed	text	animal.breed
animal-species	text	animal.species
birthdate	date	birthDate
careprovider	reference	careProvider
deathdate	date	deceasedDateTime
deceased	text	deceased[x]
email	text	telecom.value, telecom.system
family	text	name.family
gender	text	gender
given	text	name.given
identifier	text	identifier
language	text	communication.language
link	reference	link.other
name	text	name
organization	reference	managingOrganization
phone	text	telecom.value, telecom.system
phonetic	text	name
telecom	text	telecom.value, telecom.system