Patient - FHIR Resource (stu3)
This Patient Resource uses the FHIR API standard for access and structure.
Validate an Patient FHIR Resource (stu3)
Patient Attributes
AttributeField is listTypeDescription
Description: Organization that is the custodian of the patient record
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"managingOrganization": {
"reference": "Organization/1"
}Learn more about the (Patient) managingOrganization FHIR attribute
Description: Marital (civil) status of a patient
FHIR Version: stu3
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: A name associated with the patient
FHIR Version: stu3
Attribute Type : HumanName
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"name": [
{
"use": "official",
"given": [
"Peter",
"James"
],
"family": "Chalmers"
},
{
"use": "usual",
"given": [
"Jim"
]
},
{
"use": "maiden",
"given": [
"Peter",
"James"
],
"family": "Windsor",
"period": {
"end": "2002"
}
}
]Learn more about the (Patient) name FHIR attribute
Description: A contact detail for the individual
FHIR Version: stu3
Attribute Type : ContactPoint
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"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"
}
}
]Learn more about the (Patient) telecom FHIR attribute
Description: male | female | other | unknown
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"gender": "male"Learn more about the (Patient) gender FHIR attribute
Description: "multipleBirthInteger" : <integer>,
FHIR Version: stu3
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: stu3
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: stu3
Attribute Type : date
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"birthDate": "1974-12-25"Learn more about the (Patient) birthDate FHIR attribute
Description: "deceasedBoolean" : <boolean>,
FHIR Version: stu3
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"deceasedBoolean": falseLearn more about the (Patient) deceasedBoolean FHIR attribute
Description: A contact party (e.g. guardian, partner, friend) for the patient
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"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"
}
}
]Learn more about the (Patient) contact FHIR attribute
Description: Patient's nominated primary care provider
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"generalPractitioner": Learn more about the (Patient) generalPractitioner FHIR attribute
Description: This patient is known to be an animal (non-human)
FHIR Version: stu3
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: stu3
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: stu3
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"active": trueLearn more about the (Patient) active FHIR attribute
Description: Link to another patient resource that concerns the same actual person
FHIR Version: stu3
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: "multipleBirthBoolean" : <boolean>,
FHIR Version: stu3
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: stu3
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"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"
}
]
}
}
]Learn more about the (Patient) identifier FHIR attribute
Description: Addresses for the individual
FHIR Version: stu3
Attribute Type : Address
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"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"
}
]Learn more about the (Patient) address FHIR attribute
Description: "deceasedDateTime" : "<dateTime>",
FHIR Version: stu3
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 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> ("Jim")\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 them like so:
https://api.1up.health/fhir/stu3/Patient?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
active | text | active |
address | text | address.line, address.city, address.state, address.country, address.postalCode, address.text |
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 |
death-date | date | deceased.as |
deceased | text | deceased.exists |
email | text | telecom.where |
family | text | name.family |
gender | text | gender |
general-practitioner | reference | generalPractitioner |
given | text | name.given |
identifier | text | identifier |
language | text | communication.language |
link | reference | link.other |
name | text | name.family, name.give, name.prefix, name.suffix, name.suffix, name.text |
organization | reference | managingOrganization |
phone | text | telecom.where |
phonetic | text | name |
telecom | text | telecom |
