FHIR Patient
Copyright 2024 Brightstreet Group
The following is a description of a Patient that can be submitted to a Community Information Exchange Hub. For detailed information please visit the HL7 FHIR page http://hl7.org/fhir/us/core/STU4/StructureDefinition-us-core-patient.html Note that, for purposes of this documentation and its use in exchanging social services information, patient is equivalent to any community member and is simply the FHIR “person” data structure.
Typically, this would be used to provide demographic or information necessary for an outreach or other service to be requested for this community member, as well as to establish their unique identity for further information exchange (status, interventions, etc.) in the future.
Operations
The following are operations that can be performed and links to:
Sample Object
{
"active": true,
"address": [
{
"city": "Springfield",
"district": "CALHOUN",
"line": [
"TEST Ave, "
],
"postalCode": "49037",
"state": "MI",
"text": "TEST Ave, Springfield, MI, 49037",
"type": "physical",
"use": "old"
}
],
"birthDate": "YYYY-MM-DD",
"communication": [
{
"language": {
"coding": [
{
"code": "en-US",
"display": "English"
}
]
},
"preferred": true
}
],
"deceasedBoolean": false,
"extension": [
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
"valueString": "White / Caucasian"
},
{
"url": "http://hl7.org/fhir/us/military-service/StructureDefinition/military-service-veteran-status",
"valueBoolean": false
},
{
"url": "https://mi-cie.org/fhir/StructureDefinition/affiliated-tribes",
"valueString": ""
},
{
"url": "https://mi-cie.org/fhir/StructureDefinition/disability-status",
"valueBoolean": false
},
{
"url": "https://mi-cie.org/fhir/StructureDefinition/modified-by-user",
"valueString": "Megan Janik"
},
{
"url": "https://mi-cie.org/fhir/StructureDefinition/total-household-members",
"valueString": "3"
},
{
"url": "https://mi-cie.org/fhir/StructureDefinition/tribal-affiliation",
"valueBoolean": false
}
],
"gender": "female",
"id": "b577fb46-1234-475a-8ab3-d95612068769",
"identifier": [
{
"system": "https://membersupport.gryp-cie.org",
"type": {
"text": "cieGenerationOneId"
},
"use": "official",
"value": "b577fb46-1234-475a-8ab3-d95612068769"
},
{
"system": "https://www.michigancsanetwork.org/",
"type": {
"text": "IntakeId"
},
"use": "official",
"value": "129780222"
},
{
"system": "https://www.michigancsanetwork.org/",
"type": {
"text": "PersonId"
},
"use": "official",
"value": "373966"
},
{
"system": "https://csa.org",
"type": {
"text": "smsConsent"
},
"use": "official",
"value": "No"
}
],
"meta": {
"lastUpdated": "2024-05-24T15:01:32.754921+00:00",
"versionId": "MTcxNjU2Mjg5Mjc1NDkyMTAwMA"
},
"name": [
{
"family": "LASTNAME",
"given": [
"FIRSTNAME"
],
"use": "official"
}
],
"resourceType": "Patient",
"telecom": [
{
"rank": 1,
"system": "phone",
"use": "mobile",
"value": "(555) 555-5555"
},
{
"rank": 2,
"system": "phone",
"use": "home",
"value": "(444) 444-4444"
},
{
"rank": 1,
"system": "email",
"use": "home",
"value": "TEST@email.com"
}
]
}
Field Descriptions
The following are descriptions of each of the attributes in a FHIR patient resource.
Field | Description | References |
|
---|---|---|---|
name | Contains the full name of the patient including first, middle and last name. | https://build.fhir.org/patient-definitions.html#Patient.name | name_0_family (last) name_0_given_0 (first) name_0_given_1 (middle) name_0_text name_0_use |
identifiers | Represents a array of identifiers for this Patient. An example would be if the patient has a MRN number with a health system. That id will be stored along with the system of record for that id. | https://build.fhir.org/patient-definitions.html#Patient.identifier | identifier_x_system identifier_x_type_text identifier_x_use identifier_x_value *Where x is the index in the array with 0 being the first. |
active | If the patient record is active. | https://build.fhir.org/patient-definitions.html#Patient.active | active |
gender | The gender of the patient. | https://build.fhir.org/patient-definitions.html#Patient.gender | gender |
birthDate | The birthdate of the patient in the following format YYYY-MM-DD. | https://build.fhir.org/patient-definitions.html#Patient.birthDate | birthDate |
telecom | A list of the contacts for this person. It can be phone numbers, text numbers or emails. | https://build.fhir.org/patient-definitions.html#Patient.telecom | telecom_x_system (phone or email) telecom_x_use (mobile or home) telecom_x_value *Where x is the index in the array with 0 being the first. |
communication | The languages that are spoken by this patient with a preferred language. | https://build.fhir.org/patient-definitions.html#Patient.communication | communication_0_language_coding_0_code (ISO language code) communication_0_language_coding_0_display communication_0_preferred |
address | A list of addresses for this patient. | https://build.fhir.org/patient-definitions.html#Patient.address | address_x_city address_x_country address_x_district address_x_line_0 address_x_postalCode address_x_state address_0_use *Where x is the index in the array with 0 being the first. |
managingOrganization | The managing organization for this patient. This will be in most cases the CIE Hub Region. | https://build.fhir.org/patient-definitions.html#Patient.managingOrganization |
|
extension. | The preference of communication which can be either email or text as reported by the patient |
| patient_preferenceType_0_value_string |
extension. | The race and ethnicity of the patient as reported by the patient. |
| us_core_race_0_value_string |
extension. | Is this person a veteran as reported by the patient. |
| military_service_veteran_status_0_value_boolean |
extension. | The primary source of income reported by the patient. |
| primary-source-income_0_value_string |
extension. | The combined household income reported by the patient. |
| combined_household_income_0_value_string |
extension.affliatedTribes | The affiliated tribe of this patient. |
| affiliated_tribes_0_value_string |
extension.highest-level-education | Represents the highest level education that this client reached. |
| highest_level_education_0_value_string |
extension.total-household-members | Number of members in the household. |
| total_household_members_0_value_string |
extension.tribal-affiliation | This is a yes or no if the patient is affiliated with a tribe. |
| tribal_affiliation_0_value_boolean |