Patient - FHIR Resource (dstu2)
This Patient Resource uses the FHIR API standard for access and structure.
Validate an Patient FHIR Resource (dstu2)
Patient Attributes
AttributeField is listTypeDescription
Description: Organization that is the custodian of the patient record
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"managingOrganization": Learn more about the (Patient) managingOrganization FHIR attribute
Description: Marital (civil) status of a patient
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"maritalStatus": Learn more about the (Patient) maritalStatus FHIR attribute
Description: Patient's nominated primary care provider
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"careProvider": Learn more about the (Patient) careProvider FHIR attribute
Description: A name associated with the patient
FHIR Version: dstu2
Attribute Type : HumanName
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"name": Learn more about the (Patient) name FHIR attribute
Description: A contact detail for the individual
FHIR Version: dstu2
Attribute Type : ContactPoint
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"telecom": Learn more about the (Patient) telecom FHIR attribute
Description: male | female | other | unknown
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"gender": Learn more about the (Patient) gender FHIR attribute
Description: "multipleBirthInteger" : <integer>,
FHIR Version: dstu2
Attribute Type : integer
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"multipleBirthInteger": Learn more about the (Patient) multipleBirthInteger FHIR attribute
Description: A list of Languages which may be used to communicate with the patient about his or her health
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"communication": Learn more about the (Patient) communication FHIR attribute
Description: The date of birth for the individual
FHIR Version: dstu2
Attribute Type : date
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"birthDate": Learn more about the (Patient) birthDate FHIR attribute
Description: "deceasedBoolean" : <boolean>,
FHIR Version: dstu2
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"deceasedBoolean": Learn more about the (Patient) deceasedBoolean FHIR attribute
Description: A contact party (e.g. guardian, partner, friend) for the patient
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contact": Learn more about the (Patient) contact FHIR attribute
Description: Link to another patient resource that concerns the same actual person
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"link": Learn more about the (Patient) link FHIR attribute
Description: This patient is known to be an animal (non-human)
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"animal": Learn more about the (Patient) animal FHIR attribute
Description: Image of the patient
FHIR Version: dstu2
Attribute Type : Attachment
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"photo": Learn more about the (Patient) photo FHIR attribute
Description: Whether this patient's record is in active use
FHIR Version: dstu2
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"active": Learn more about the (Patient) active FHIR attribute
Description: "multipleBirthBoolean" : <boolean>,
FHIR Version: dstu2
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"multipleBirthBoolean": Learn more about the (Patient) multipleBirthBoolean FHIR attribute
Description: An identifier for this patient
FHIR Version: dstu2
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (Patient) identifier FHIR attribute
Description: Addresses for the individual
FHIR Version: dstu2
Attribute Type : Address
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"address": Learn more about the (Patient) address FHIR attribute
Description: "deceasedDateTime" : "<dateTime>",
FHIR Version: dstu2
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"deceasedDateTime": Learn more about the (Patient) deceasedDateTime FHIR attribute
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 |
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 |
phonetic | text | name |
telecom | text | telecom |
