Patient
Terminology Bindings
| Terminology | Detail |
|---|---|
| Patient.identifier | An identifier - identifies some entity uniquely and unambiguously. Identifier can be used for to retrieve clinical data. |
| Patient.communication.language | The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English.. |
Parameters
| Parameter | Is Required | Description |
|---|---|---|
| _id | This, identifier, or name. | The logical resource ID associated with the resource. |
| identifier | This, _id, or name | The logical resource ID associated with the resource. |
| name | This, _id, or identifier | The start of either the family or the given name of the patient. Example: Doe |
| birthdate | No | The patient's date of birth. Example: 1993-01-01 |
| gender | No | The patient's gender. Example: female |
| _revinclude | No | A request to include any Provenance resource in the bundle. |
Requests
Patient by _id, identifier, name, birthdate, gender
GET: 'https://api.practicestudio.net/patientportal/fhir/Patient?_id={Patient_ID}'
GET: 'https://api.practicestudio.net/patientportal/fhir/Patient?identifier={Patient_ID}'
GET: 'https://api.practicestudio.net/patientportal/fhir/Patient?name={Patient_Name}'
GET: 'https://api.practicestudio.net/patientportal/fhir/Patient?birthdate=1998-10-19&name={Patient_Name}'
GET: 'https://api.practicestudio.net/patientportal/fhir/Patient?gender=female&name={Patient_Name}'
Example Response
Example Patient JSON Response:
{
"resourceType": "Bundle",
"meta": {
"lastUpdated": "2022-08-29T10:43:40.3472707-05:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://api.practicestudio.net/patientportal/fhir/Patient?identifier=000034&offset=0"
}
],
"entry": [
{
"fullUrl": "https://api.practicestudio.net/patientportal/fhir/Patient/000034",
"resource": {
"resourceType": "Patient",
"id": "000034",
"meta": {
"lastUpdated": "0001-01-01T00:00:00-06:00",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
]
},
"extension": [
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
"valueCode": "F"
},
{
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2106-3",
"display": "White",
"userSelected": false
}
},
{
"url": "text",
"valueString": "White"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
},
{
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2135-2",
"display": "Hispanic Or Latino",
"userSelected": false
}
},
{
"url": "text",
"valueString": "Hispanic Or Latino"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
}
],
"identifier": [
{
"use": "usual",
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"value": "000034"
}
],
"active": true,
"name": [
{
"use": "official",
"family": "Taylor",
"given": [
"Lucy"
]
}
],
"telecom": [
{
"system": "phone",
"value": "(806) 382-7442",
"use": "mobile",
"rank": 1
},
{
"system": "other",
"value": "(806) 822-1800",
"use": "home",
"rank": 2
},
{
"system": "phone",
"value": "(806) 222-5555 x1234",
"use": "work",
"rank": 3
},
{
"system": "email",
"value": "bryanhill_7@yahoo.com",
"use": "home"
}
],
"gender": "female",
"birthDate": "1998-10-19",
"deceasedBoolean": false,
"address": [
{
"text": "1234 Main St, Amarillo, TX 79109",
"line": [
"MicroFour.PS.Edi.HL7.FhirR4.string"
],
"city": "Amarillo",
"state": "TX",
"postalCode": "79109",
"country": "US",
"period": {
"start": "2022-08-29",
"end": "2022-08-29"
}
}
],
"maritalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
"code": "U",
"display": "unmarried",
"userSelected": false
}
]
},
"contact": [
{
"relationship": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0131",
"code": "U",
"display": "Unkonwn",
"userSelected": false
}
]
}
],
"name": {
"family": "Anderson",
"given": [
"Janet"
]
},
"telecom": [
{
"system": "phone",
"value": "(806) 382-7442",
"use": "mobile",
"rank": 1
},
{
"system": "phone",
"value": "(806) 674-5983",
"use": "mobile",
"rank": 7
},
{
"system": "phone",
"value": "(806) 111-1111",
"use": "home",
"rank": 8
}
],
"address": {
"text": "1234 Oak Ave, Amarillo, TX 79109",
"line": [
"MicroFour.PS.Edi.HL7.FhirR4.string"
],
"city": "Amarillo",
"state": "TX",
"postalCode": "79109",
"country": "US"
}
}
],
"communication": [
{
"language": {
"coding": [
{
"system": "urn:ietf:bcp:47",
"code": "en",
"display": "English",
"userSelected": false
}
]
},
"preferred": true
}
]
},
"search": {
"mode": "match",
"score": 1
}
}
]
}