Search API
This API allows to search different resources like patient, condition, encounter, episodeofcare, coverage and questionnaireresponse using various search parameters/filters. The parameters would vary and depend on the resource used for search.
The API would return different response codes as shown below, when a search request is made.
The API would return different response codes as shown below, when a search request is made.
HTTP Response Codes
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful |
| 400 | Bad Request | Submission Error (Parameter formatting, ex.) |
| 403 | Forbidden | Invalid/Missing Token |
| 404 | Not Found | Incorrect Endpoint |
| 500 | Internal Error | Generic System Error |
Base Url
https://hidex-portal-uat.azurewebsites.net/
Search By Resources
Patient
Client's information can be fetched, by using Patient search endpoint. There are different parameters available to perform patient search. If the Api call is successful, the Status will display a response of “200 OK”, with patient information. For failure response http codes, please refer the HTTP Response codes table, for a status and description.
Available searches under Patient
| QueryParameter | R/O | Description | Format |
|---|---|---|---|
| Family | O | Last Name | Alpha |
| Given | O | First Name | Alpha |
| Alias | O | Alias Name | Alpha |
| SSN | O | Social Security Number | ###-##-#### |
| Birthdate | O | YYYY-MM-DD | YYYY-MM-DD |
| Start | O | Start Date of Birth Range | YYYY-MM-DD |
| End | O | End Date of Birth Range | YYYY-MM-DD |
| Gender | O | Gender | Alpha lowercase(male/female/unknown) |
| _id | O | Patient ID | Integer |
Syntax: GET [Base Url]/Patient/Search?{[QueryParameter=value]}
Search Response
| FHIR Element | AV Field | Description |
|---|---|---|
| id | Client Number | Unique Identifier |
| extension: us-core-genderIdentity | Gender Identity | Gender Identity, example Female-to-Male, Male-to-Female, Male, Female |
| extension: us-core-birthsex | Sex | Patient’s Sex at Birth |
| gender | Sex | Patient’s Gender |
| extension: patient-sexualOrientation | Sexual Orientation | Patient’s Sexual Orientation |
| extension: patient-employmentStatus | Employment Status | Patient’s Employment Status |
| extension: patient-educationLevel | Education Level | Patient’s Education Level |
| identifier.type.coding.code: "SS" identifier.value |
Social Security Number | Patient’s Social Security Number |
| name.family | Client Last Name | Patient’s Last Name |
| name.given | Client First Name | Patient’s First Name |
| name.given | Client Middle Name | Patient’s Middle Name |
| name.prefix | Prefix | Patient’s Prefix |
| name.suffix | Suffix | Patient’s Suffix |
| name.text(1) | Alias | Patient’s Alias |
| name.text(2-10) | Alias (2-10) | Patient’s Aliases |
| telecom.system: "phone" telecom.use: "home" telecom.value |
Client's Home Phone | Patient’s Home Phone |
| telecom.system: "phone" telecom.use: "work" telecom.value |
Client's Work Phone | Patient’s Work Phone |
| telecom.system: "email" telecom.use: "mobile" telecom.value |
Client's Email Address | Patient’s Email Address |
| birthDate | Date of Birth | Patient’s Date of Birth |
| address.line | Client's Address - Street | Patient’s Street address |
| address.line | Client's Address - Street 2 | Patient’s Street Address |
| address.city | Client's Address - City | Patient’s Address- City |
| address.district | Client's Address - District | Patient’s Address- County |
| address.state | Client's Address - State | Patient’s Address- State |
| address.postalCode | Client's Address -Zipcode | Patient’s Address -Zipcode |
| maritalStatus.coding.code | Marital Status | Patient’s Marital Status |
| communication.language.coding.code | Primary Language | Patient’s Primary Language |
Sample Response Body (Patient)
{
"resourceType": "Patient",
"id": "160785",
"meta": {
"lastUpdated": "2023-08-18T11:23:00.000+00:00"
},
"extension": [{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity",
"valueCodeableConcept": {
"coding": [{
"system": "urn:oid:2.16.840.1.113883.4.642.3.972",
"code": "446141000124107",
"display": "Female"
}]
}
},
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
"valueCode": "F"
},
{
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/patient-sexualOrientation",
"valueCodeableConcept": {
"coding": [{
"system": "urn:oid:2.16.840.1.113883.4.642.3.29",
"code": "38628009",
"display": "Lesbian, gay or homosexual"
}]
}
},
{
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/patient-employmentStatus",
"valueCodeableConcept": {
"coding": [{
"code": "2",
"display": "Part Time (16-32 Hours A Week Not Including Armed Forces)"
}]
}
},
{
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/patient-educationLevel",
"valueCodeableConcept": {
"coding": [{
"code": "3",
"display": "3 Years"
}]
}
}
],
"identifier": [{
"type": {
"coding": [{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "SS",
"display": "Social Security Number"
}]
},
"system": "http://hl7.org/fhir/sid/us-ssn",
"value": "562345678"
},
{
"use": "usual",
"type": {
"coding": [{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR"
}]
},
"system": "urn:oid:1.2.36.146.595.217.0.1",
"value": "160785"
}
],
"name": [{
"use": "usual",
"text": "MeMetest",
"family": "DOE",
"given": [
"JANE",
"MARY"
]
},
{
"use": "old",
"text": "MEMETEST1"
},
{
"use": "old",
"text": "MEMETEST2"
},
{
"use": "old",
"text": "MEMETEST3"
},
{
"use": "old",
"text": "MEMETEST4"
},
{
"use": "old",
"text": "MEMETEST5"
},
{
"use": "old",
"text": "TEST WOMAN",
"family": "WOMAN",
"given": [
"TEST"
],
"period": {
"start": "2023-01-11T12:00:00+00:00",
"end": "2023-06-20T12:00:00+00:00"
}
},
{
"use": "old",
"text": "WOMANTEST WOMANTEST",
"family": "WOMANTEST",
"given": [
"WOMANTEST"
],
"period": {
"start": "2023-06-20T12:00:00+00:00",
"end": "2023-06-22T12:00:00+00:00"
}
},
{
"use": "old",
"text": "JOHN DOE",
"family": "DOE",
"given": [
"JOHN"
],
"period": {
"start": "2023-06-22T12:00:00+00:00",
"end": "2023-07-12T12:00:00+00:00"
}
},
{
"use": "old",
"text": "JOHN BOB DOE",
"family": "DOE",
"given": [
"JOHN",
"BOB"
],
"period": {
"start": "2023-07-12T12:00:00+00:00",
"end": "2023-07-17T12:00:00+00:00"
}
},
{
"use": "old",
"text": "JON BOB DOE",
"family": "DOE",
"given": [
"JON",
"BOB"
],
"period": {
"start": "2023-07-17T12:00:00+00:00",
"end": "2023-08-10T12:00:00+00:00"
}
},
{
"use": "old",
"text": "JOHN BOB DOE",
"family": "DOE",
"given": [
"JOHN",
"BOB"
],
"period": {
"start": "2023-08-10T12:00:00+00:00",
"end": "2023-08-10T12:00:00+00:00"
}
},
{
"use": "old",
"text": "JOHN ROB DOE",
"family": "DOE",
"given": [
"JOHN",
"ROB"
],
"period": {
"start": "2023-08-10T12:00:00+00:00",
"end": "2023-08-10T12:00:00+00:00"
}
}
],
"telecom": [{
"system": "phone",
"value": "5553545555",
"use": "home"
},
{
"system": "phone",
"value": "5553545555",
"use": "work"
},
{
"system": "phone",
"value": "5553545555",
"use": "mobile"
},
{
"system": "email",
"value": "test@test.com",
"use": "mobile"
}
],
"gender": "female",
"birthDate": "1988-08-25",
"deceasedBoolean": false,
"address": [{
"use": "home",
"line": [
"1000 S. Fremont",
"Suite 500"
],
"city": "Alhambra",
"district": "19",
"state": "CA",
"postalCode": "91803",
"period": {
"start": "2023-07-17T12:00:00+00:00"
}
},
{
"line": [
"123 Main Street",
"Apt 220"
],
"city": "Los Angeles",
"district": "19",
"state": "CA",
"postalCode": "90025",
"period": {
"start": "2023-07-17T12:00:00+00:00"
}
}
],
"maritalStatus": {
"coding": [{
"code": "2",
"display": "Married"
}]
},
"communication": [{
"language": {
"coding": [{
"code": "7",
"display": "English"
}]
},
"preferred": true
}]
}
Observation
Client's all observations(smoking statuses) can be fetched, by using Observation Search endpoint. There are four different parameters available for search. If the Api call is successful, the Status will display a response of “200 OK”, with list of observations. For failure response http codes, please refer the HTTP Response codes table, for a status and description.
Available searches under Observation
| QueryParameter | R/O | Description | Format |
|---|---|---|---|
| Patient | R | Patient ID | Integer |
| category | O | Need to be: social-history | social-history |
| code | O | Code | {number}-{number} e.g 72166-2 |
| _id | O | Observation Identifier | social-history_{PATID--ObservationID} e.g social-history_121256--MPI67039.002 |
Syntax: GET [Base Url]/Observation/Search?{[QueryParameter=value]}
Search Response
| FHIR Element | AV Field | Description |
|---|---|---|
| id | Observation ID | Observation ID |
| category | Category | |
| subject | Client Number | Patient Id |
| effectiveDateTime | Smoker Status Assessment Date | Smoker Status Assessment Date |
| valueCodeableConcept | Smoker | Smoker |
Sample Response Body (Observation)
{
"resourceType": "Bundle",
"id": "a29393ae-29b6-4211-b0cd-a76168161d29",
"meta": {
"lastUpdated": "2024-07-22T18:40:58.519+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://fhirtest.netsmartcloud.com/v4/Observation?patient=121250&category=social-history&page=1"
}
],
"entry": [
{
"fullUrl": "https://fhirtest.netsmartcloud.com/v4/Observation/social-history_121250--MPI67037.001",
"resource": {
"resourceType": "Observation",
"id": "social-history_121250--MPI67037.001",
"meta": {
"lastUpdated": "2024-07-16T15:50:00+00:00"
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "social-history",
"display": "Social History"
}
],
"text": "Social History"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "72166-2",
"display": "Tobacco smoking status"
}
],
"text": "Tobacco smoking status"
},
"subject": {
"reference": "Patient/121250",
"type": "Patient"
},
"effectiveDateTime": "2019-10-15T12:00:00+00:00",
"issued": "2019-10-15T12:00:00+00:00",
"valueCodeableConcept": {
"coding": [
{
"code": "2",
"display": "Former Smoker"
},
{
"system": "urn:oid:2.16.840.1.113883.6.96",
"code": "8517006",
"display": "Ex-smoker"
},
{
"system": "http://loinc.org",
"code": "68535-4",
"display": "Have used tobacco in the last 30 days [SAMHSA]"
}
]
}
}
}
]
}
Encounter
Client's all Encounters can be fetched, by using Encounter Search endpoint. The parameter required is patid. If the Api call is successful, the Status will display a response of “200 OK”, with list of encounters. For failure response http codes, please refer the HTTP Response codes table, for a status and description.
Available searches under Encounter
| QueryParameter | R/O | Description | Format |
|---|---|---|---|
| Patid | R | Patient Identifier | Integer |
Syntax: GET [Base Url]/Encounter/Search?{[QueryParameter=value]}
Search Response
| FHIR Element | AV Field | Description |
|---|---|---|
| id | Encounter Unique Record ID | Encounter Unique Record ID |
| extension: encounter-hospitalServiceReference | Program | |
| Participant | Admitting Practitioner | |
| Period.start | Preadmit/Admission Time |
Sample Response Body (Encounter)
{
"resourceType": "Bundle",
"id": "463abdb2-c3da-4acd-bad0-7e736593cf56",
"meta": {
"lastUpdated": "2024-05-08T22:05:30.788+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://fhirtest.netsmartcloud.com/v4/Encounter?patient=160785&status=arrived&page=1"
}
],
"entry": [
{
"fullUrl": "https://fhirtest.netsmartcloud.com/v4/Encounter/arrived_160785--6611.91",
"resource": {
"resourceType": "Encounter",
"id": "arrived_160785--6611.91",
"meta": {
"lastUpdated": "2023-06-08T19:19:00+00:00"
},
"extension": [
{
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/encounter-admissionSource",
"valueCodeableConcept": {
"coding": [
{
"code": "2",
"display": "Other health care provider"
}
]
}
},
{
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/encounter-hospitalServiceReference",
"valueReference": {
"reference": "HealthcareService/LE5100",
"type": "HealthcareService"
}
},
{
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/encounter-programCode",
"valueCodeableConcept": {
"coding": [
{
"code": "LE5100",
"display": "MATRIX INSTITUTE ON ADDICTIONS"
}
]
}
},
{
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/encounter-is-perform-discharge-alert",
"valueBoolean": false
},
{
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/encounter-is-prescreened",
"valueBoolean": false
},
{
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/encounter-is-school-record-requested",
"valueBoolean": false
},
{
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/encounter-is-immunization-record-requested",
"valueBoolean": false
},
{
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/encounter-is-informed-of-smoking-policy",
"valueBoolean": false
},
{
"extension": [
{
"url": "period",
"valuePeriod": {
"start": "2023-07-16T12:00:00+00:00",
"end": "2023-07-17T12:00:00+00:00"
}
},
{
"url": "veteran",
"valueBoolean": true
},
{
"url": "military-related-disability",
"valueBoolean": true
},
{
"url": "branch-of-service",
"valueCode": "2"
}
],
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/encounter-military-service"
}
],
"identifier": [
{
"id": "160785--6611.91",
"type": {
"coding": [
{
"code": "urn:oid:2.16.840.1.113883.4.642.1.1088"
}
]
},
"system": "urn:oid:2.16.840.1.113883.4.642.1.1088",
"value": "160785--6611.91"
}
],
"status": "arrived",
"subject": {
"reference": "Patient/160785",
"type": "Patient"
},
"episodeOfCare": [
{
"reference": "EpisodeOfCare/160785--2",
"type": "EpisodeOfCare"
}
],
"participant": [
{
"type": [
{
"coding": [
{
"system": "urn:oid:2.16.840.1.113883.6.96",
"code": "ADMPHYS",
"display": "Admitting Physician"
}
]
}
],
"period": {
"start": "2022-01-10T16:25:00+00:00"
},
"individual": {
"reference": "Practitioner/000001",
"type": "Practitioner"
}
}
],
"period": {
"start": "2022-01-10T19:25:00+00:00"
}
}
}
]
}
Condition
Client's Diagnosis/Pregnancy information can be fetched, by using Condition search endpoint. There are different parameters available to perform Condition search. If the Api call is successful, the Status will display a response of “200 OK”, with list of condition information. For failure response http codes, please refer the HTTP Response codes table, for a status and description.
Available searches under Condition - Diagnosis
Search Diagnosis by PatientID and EncounterId
| QueryParameter | R/O | Description | Format |
|---|---|---|---|
| category | R | Need tobe:encounter-diagnosis | encounter-diagnosis |
| patient | R | Patient ID | Integer |
| start | R | onset date (required forworkaround) | 1846-01-01 |
Search Diagnosis by DiagnosisId
| QueryParameter | R/O | Description | Format |
|---|---|---|---|
| _id | R | DiagnosisIdentifier | encounter-diagnosis_{DiagnosisID} e.g encounter-diagnosis_90596--293167 |
Available searches under Condition - Pregnancy
Search Pregnancy by Patient Id
| QueryParameter | R/O | Description | Format |
|---|---|---|---|
| category | R | Need to be: pregnancy | pregnancy |
| patient | R | Patient ID | Integer e.g 160785 |
Syntax: GET [Base Url]/Condition/Search?{[QueryParameter=value]}
Search Response for Condition - Diagnosis
| FHIR Element | AV Field | Description |
|---|---|---|
| id | Diagnosis Unique Record ID | Unique Record ID for Diagnosis |
| extension: condition-diagnosisRole | Type of Diagnosis | Type of Diagnosis |
| extension: condition-diagnosisRank | Ranking | Ranking Of Diagnosis |
| extension: condition-diagnosisBillOrder | Bill Order | Bill Order of Diagnosis |
| category.coding.code: "encounter-diagnosis" | N/A | Encounter-Diagnosis |
| severity.coding.code | General Medical Condition Summary Code (CSI) | General Medical Condition Summary Code (CSI) |
| code.coding.code | ICD-10 Code | ICD-10 Code |
| subject.id subject.reference |
Client Number | Client Number |
| encounter.id encounter.reference |
Admission Unique Record ID | Admission Unique Record ID |
| onsetDateTime | Date of Diagnosis/Estimated Onset Date | Date of Diagnosis/Estimated Onset Date |
| abatementDateTime | Estimated Discharge Date (CSI) | Estimated Discharge Date (CSI) |
| asserter.id asserter.reference |
Diagnosing Practitioner | Diagnosing Practitioner |
| evidence.detail.reference: "SUBSTANCE_ABUSE_DEPENDENCE" evidence.code.coding.code |
Substance Abuse / Dependence (CSI) | Substance Abuse / Dependence (CSI) |
| evidence.detail.reference: "TRAUMA" evidence.code.coding.code |
Trauma (CSI) | Trauma (CSI) |
| evidence.detail.reference: "SUBSTANCE_ABUSE_DEPENDENCE_DIAGNOSIS" evidence.code.coding.code |
Substance Abuse / Dependence Diagnosis (CSI) | Substance Abuse / Dependence Diagnosis (CSI) |
Search Response for Condition - Pregnancy
| FHIR Element | AV Field | Description |
|---|---|---|
| id | Pregnancy Unique Record ID | Pregnancy Unique Record ID |
| subject.reference | Client Number | Client Number |
| encounter.id encounter.reference |
Admission Unique Record ID | Admission Unique Record ID |
| onsetDateTime | Pregnancy Billing Start Date | Pregnancy Billing Start Date |
| abatementDateTime | Pregnancy Billing End Date | Pregnancy Billing End Date |
| recordedDate | Assessment Date | Assessment Date |
Sample Response Body (Condition - Diagnosis)
{
"resourceType": "Condition",
"id": "encounter-diagnosis_90832--293439",
"meta": {
"lastUpdated": "2023-07-07T21:59:00.000+00:00"
},
"extension": [
{
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/condition-status-code",
"valueCode": "4"
},
{
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/condition-diagnosisRole",
"valueCodeableConcept": {
"coding": [
{
"code": "A",
"display": "Admission"
}
]
}
},
{
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/condition-diagnosisRank",
"valueCodeableConcept": {
"coding": [
{
"code": "1",
"display": "Primary"
}
]
}
},
{
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/condition-diagnosisBillOrder",
"valueInteger": 1
}
],
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-category",
"code": "encounter-diagnosis"
}
]
}
],
"severity": {
"coding": [
{
"system": "UNKNOWN",
"code": "UNKNOWN"
}
]
},
"code": {
"coding": [
{
"system": "urn:oid:2.16.840.1.113883.6.90",
"code": "A92.5",
"display": "Zika virus disease"
}
]
},
"subject": {
"id": "160785"
},
"encounter": {
"id": "160785--6648.51"
},
"onsetDateTime": "2023-06-20T00:00:00+00:00",
"abatementDateTime": "2023-06-25T12:00:00+00:00",
"asserter": {
"id": "000001"
},
"evidence": [
{
"code": [
{
"coding": [
{
"code": "Y",
"display": "Yes"
}
]
}
],
"detail": [
{
"reference": "SUBSTANCE_ABUSE_DEPENDENCE"
}
]
},
{
"code": [
{
"coding": [
{
"code": "N",
"display": "No"
}
]
}
],
"detail": [
{
"reference": "TRAUMA"
}
]
}
]
}
EpisodeOfCare
Client's all Episodes can be fetched, by using EpisodeOfCare Search endpoint. There are different parameters available to perform EpisodeOfCare search. If the Api call is successful, the Status will display a response of “200 OK”, with list of episodes. For failure response http codes, please refer the HTTP Response codes table, for a status and description.
Available searches under Episode
| QueryParameter | R/O | Description | Format |
|---|---|---|---|
| Patient | O | Patient Identifier | integer |
| _id | O | Episode Of Care Identifier |
{PATID}--{EpisodeID} e.g 160785--2 |
Syntax: GET [Base Url]/EpisodeOfCare/Search?{[QueryParameter=value]}
Search Response
| FHIR Element | AV Field | Description |
|---|---|---|
| id | EpisodeofCareUnique Record ID | Unique Record ID for Episode |
| status | Status | Status of Episode of Care |
| Type_code | Typecode | Type of Episode of Care (ex. Admit) |
| Type_system | Program | Program Name |
| diagnosis | Diagnosis Unique Record ID | Unique Record ID for Diagnosis |
| extension: condition-diagnosisRole | Type of Diagnosis | Type of Diagnosis |
| patient | Client Number | Unique Identifier |
| period | Start date | Start date of Episode of Care |
Sample Response Body (Episode)
{
"resourceType": "Bundle",
"id": "7a9f4eda-27c0-4ed1-8fb8-d4599ca1f4e1",
"meta": {
"lastUpdated": "2023-08-18T16:24:19.250+00:00"
},
"type": "searchset",
"total": 1,
"link": [{
"relation": "self",
"url": "https://fhirtest.netsmartcloud.com/v4/EpisodeOfCare?_id=160785--1&page=1"
}],
"entry": [{
"fullUrl": "http://fhir-uat-internal.netsmartcloud.com/NtstFhir-web/v4/EpisodeOfCare/160785--1",
"resource": {
"resourceType": "EpisodeOfCare",
"id": "160785--1",
"meta": {
"lastUpdated": "2023-08-16T16:13:00.000+00:00"
},
"status": "active",
"type": [{
"coding": [{
"code": "Admit",
"display": "Admit"
}]
}, {
"coding": [{
"system": "Program",
"code": "LE11800",
"display": "ACTION FAMILY COUNSELING - SCV INC."
}]
}],
"diagnosis": [{
"condition": {
"id": "91014--293667",
"reference": "Condition/91014--293667"
},
"role": {
"coding": [{
"system": "http://terminology.hl7.org/CodeSystem/diagnosis-role",
"code": "AD",
"display": "Admission diagnosis"
}]
}
}, {
"condition": {
"reference": "Condition/91147--293859"
},
"role": {
"coding": [{
"system": "http://terminology.hl7.org/CodeSystem/diagnosis-role",
"code": "AD",
"display": "Admission diagnosis"
}]
}
}, {
"condition": {
"reference": "Condition/90832--293439"
},
"role": {
"coding": [{
"system": "http://terminology.hl7.org/CodeSystem/diagnosis-role",
"code": "AD",
"display": "Admission diagnosis"
}]
}
}, {
"condition": {
"reference": "Condition/91074--293765"
},
"role": {
"coding": [{
"system": "http://terminology.hl7.org/CodeSystem/diagnosis-role",
"code": "AD",
"display": "Admission diagnosis"
}]
}
}],
"patient": {
"id": "160785"
},
"period": {
"start": "2023-01-11T12:00:00+00:00"
}
}
}]
}
Coverage (Client Financial Eligibility)
Client's Financial Eligibility (Coverage) can be fetched, by using Coverage Search endpoint. There are different parameters available to perform Coverage search. If the Api call is successful, the Status will display a response of “200 OK”, with list of coverages. For failure response http codes, please refer the HTTP Response codes table, for a status and description.
Available searches under Coverage (Client Financial Eligibility)
1. Search Financial Eligibility by Patient and Encounter
| QueryParameter | R/O | Description | Format |
|---|---|---|---|
| Patient | R | PatientID | Integer |
| Encounter | O | Encounter Identifier | {PATID}--{EncounterID} e.g 160785--6648.51 |
Syntax: GET [Base Url]/Coverage/Search?{[QueryParameter=value]}
2. Search Financial Eligibility by Coverage ID
| QueryParameter | R/O | Description | Format |
|---|---|---|---|
| _id | R | Coverage Identifier | {PATID}--{CoverageID}--PATIENT e.g 121250--S2.001--PATIENT |
Example: https://hidex-portal-uat.azurewebsites.net/api/Coverage/Search?_id= 121250--S2.001--PATIENT
Search Response
| FHIR Element | AV Field | Description |
|---|---|---|
| id | Financial Eligibility Unique Record ID | Financial Eligibility Unique Record ID |
| extension: coverage-birth-date | Subscriber's Birth Date | Subscriber's Birth Date |
| extension: coverage-gender | Subscriber Sex | Subscriber Sex |
| extension: coverage-relationship-code | Client's RelationshipToSubscriber | Client's RelationshipToSubscriber |
| extension: coverage-address valueAddress.line |
Subscriber Address - Street Line 1 | Subscriber Address - Street Line 1 |
| extension: coverage-address valueAddress.line |
Subscriber Address - Street Line 2 | Subscriber Address - Street Line 2 |
| extension: coverage-address valueAddress.city |
Subscriber Address - City | Subscriber Address - City |
| extension: coverage-address valueAddress.district |
Subscriber Address - County | Subscriber Address - County |
| extension: coverage-address valueAddress.state |
Subscriber Address - State | Subscriber Address - State |
| extension: coverage-address valueAddress.postalCode |
Subscriber Address - Zip | Subscriber Address - Zip |
| extension: coverage-guarantor valueHumanName.text |
Subscriber's Name | Guarantor's Name |
| extension: coverage-guarantor valueHumanName.family |
Subscriber's Name | Guarantor's Last Name |
| extension: coverage-guarantor valueHumanName.given |
Subscriber's Name | Guarantor's First Name |
| extension: coverage-guarantor valueHumanName.given |
Subscriber's Name | Guarantor's First Name |
| extension: coverage-guarantor valueHumanName.prefix |
Subscriber's Name | Guarantor's Prefix |
| extension: coverage-guarantor valueHumanName.suffix |
Subscriber's Name | Guarantor's Suffix |
| extension: coverage-subscriber-name valueHumanName.text |
Subscriber's Name | Subscriber's Name |
| extension: coverage-subscriber-name valueHumanName.family |
Subscriber's Name | Subscriber's Last Name |
| extension: coverage-subscriber-name valueHumanName.given |
Subscriber's Name | Subscriber's First Name |
| extension: coverage-subscriber-name valueHumanName.given |
Subscriber's Name | Subscriber's First Name |
| extension: coverage-subscriber-name valueHumanName.prefix |
Subscriber's Name | Subscriber's Prefix |
| extension: coverage-subscriber-name valueHumanName.suffix |
Subscriber's Name | Subscriber's Suffix |
| extension: coverage-social-security-number | Subscriber's Social Security # | Subscriber's Social Security # |
| extension: coverage-encounterReference | Admission Unique Record ID | Admission Unique Record ID |
| extension: coverage-bill-order | Guarantor#(1-20) | Guarantor#(1-20) |
| policyHolder.id policyHolder.reference |
Client Number | Client Number |
| subscriberID | Subscriber Client Index Number | Subscriber Client Index Number |
| beneficiary.reference | Client Number | Client Number |
| relationship.coding.code | Client's RelationshipToSubscriber | Client's RelationshipToSubscriber |
| period.start | Coverage Effective Date | Coverage Effective Date |
| period.end | Coverage Expiration Date | Coverage Expiration Date |
| payer.reference | Guarantor # | Guarantor # |
| order | Guarantor#(1-20) | Guarantor#(1-20) |
| network | Guarantor # | Guarantor # |
Sample Response Body (Coverage)
{
"resourceType": "Coverage",
"id": "121250--S2.001--PATIENT",
"extension": [{
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/coverage-birth-date",
"valueString": "1988-08-25T12:00:00"
}, {
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/coverage-gender",
"valueCodeableConcept": {
"coding": [{
"code": "M",
"display": "Male"
}]
}
}, {
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/coverage-relationship-code",
"valueCodeableConcept": {
"coding": [{
"code": "1",
"display": "Self"
}]
}
}, {
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/coverage-address",
"valueAddress": {
"line": ["123 Main Street", "Apt 123"],
"city": "Westwood",
"district": "19",
"state": "CA",
"postalCode": "90028"
}
}, {
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/coverage-guarantor",
"valueHumanName": {
"text": "JOHN ROB DOE",
"family": "DOE",
"given": ["JOHN", "ROB"]
}
}, {
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/coverage-subscriber-name",
"valueHumanName": {
"text": "JOHN ROB DOE",
"family": "DOE",
"given": ["JOHN", "ROB"]
}
}, {
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/coverage-social-security-number",
"valueString": "999-99-9999"
}, {
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/coverage-encounterReference",
"valueReference": {
"id": "121250--6664.01"
}
}, {
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinitition/coverage-bill-order",
"valueInteger": 1
}],
"policyHolder": {
"id": "121250"
},
"beneficiary": {
"id": "121250"
},
"relationship": {
"coding": [{
"code": "1",
"display": "Self"
}]
},
"period": {
"start": "2023-07-26T12:00:00+00:00"
},
"payor": [{
"reference": "Organization/2"
}],
"order": 1,
"network": "2"
}
QuestionnaireResponse - Cal-OMS Admission
Client's Cal-OMS Admission record can be fetched, by using QuestionnaireResponse search endpoint. There are different parameters available to perform QuestionnaireResponse search. If the Api call is successful, the Status will display a response of “200 OK”, with Admission information. For failure response http codes, please refer the HTTP Response codes table, for a status and description.
Available searches under QuestionnaireResponse Cal-OMS Admission
Search QuestionnaireResponse by PatientID
| QueryParameter | R/O | Description | Format |
|---|---|---|---|
| Questionnnaire_type | R | Type | Cal_OMS_Admission (need to be exact case) |
| Patient | O | PatientID | Integer |
Search QuestionnaireResponse by Cal-OMS Admission Id
| QueryParameter | R/O | Description | Format |
|---|---|---|---|
| _id | R | Cal-OMS Admission Identifier | {PATID}--{EpisodeID}--{CalOMSAdmissionID} e.g 160785--9--OMA.009 |
Syntax: GET [Base Url]/QuestionnaireResponse/Search?{[QueryParameter=value]}
Search Response
| FHIR Element | AV Field | Description |
|---|---|---|
| QuestionaireResponse | Cal_OMS_Admission | Cal_OMS_Admission |
| SubjectId | PatientID | Patient ID |
| Encounter Id | Encounter ID | Encounter ID |
| linkId:3 | Type of Form | Type of Form |
| linkId:1 | Episode ID | Episode ID |
| linkId:5 | Current First name | Current First name |
| linkId:6 | Current Last Name | Current Last Name |
| linkId:7 | Social Security Number | Social Security Number |
| linkId:8 | Zipcodeat Current Residence | Zipcodeat Current Residence |
| linkId:9 | Birth First Name | Birth First Name |
| linkId:10 | Birth Last Name | Birth Last Name |
| linkId:11 | Place of Birth-County | Place of Birth-County |
| linkId:12 | Place of Birth-State | Place of Birth-State |
| linkId:13 | Driver’s License Number | Driver’s License Number |
| linkId:14 | Driver’s License State | Driver’s License State |
| linkId:15 | Mother’s First Name | Mother’s First Name |
| linkId:22 | Veteran | Veteran |
| linkId:23 | Disability | Disability |
| linkId:24 | Consent | Consent |
| linkId:28 | Days WaitedoEnter Treatment | Days WaitedoEnter Treatment |
| linkId:29 | Number of Prior Episodes | Number of Prior Episodes |
| linkId:27 | Source of Referral | Source of Referral |
| linkId:84 | Admission Date | Admission Date |
| linkId:85 | Location of Admission | Location of Admission |
| linkId:86 | Level of Care Admitted | Level of Care Admitted |
Sample Response Body (Questionnaire Response)
{
"resourceType": "Bundle",
"id": "1f815ad0-16c9-4366-9026-8e945fcb01bf",
"meta": {
"lastUpdated": "2023-08-08T20:32:49.574+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://fhirtest.netsmartcloud.com/v4/QuestionnaireResponse?_id=160785--1--OMD.003&page=1"
}
],
"entry": [
{
"fullUrl": "http://fhir-uat-internal.netsmartcloud.com/NtstFhir-web/v4/QuestionnaireResponse/160785--1--OMD.003",
"resource": {
"resourceType": "QuestionnaireResponse",
"id": "160785--1--OMD.003",
"meta": {
"tag": [
{
"code": "Cal-OMS_Discharge",
"display": "Cal-OMS Discharge"
}
]
},
"subject": {
"id": "121250"
},
"authored": "2020-03-02T13:12:00+00:00",
"author": {
"id": "000001"
},
"item": [
{
"linkId": "1",
"answer": [
{
"valueString": "1"
}
]
},
{
"linkId": "3",
"answer": [
{
"valueCoding": {
"system": "70701",
"code": "4",
"display": "Discharge"
}
}
]
},
{
"linkId": "5",
"answer": [
{
"valueString": "2023-06-30"
}
]
},
{
"linkId": "6",
"answer": [
{
"valueCoding": {
"system": "70593",
"code": "1",
"display": "Completed Treatment / Recovery Plan, Goals / Referred/Standard"
}
}
]
},
{
"linkId": "8",
"answer": [
{
"valueString": "Emily"
}
]
},
{
"linkId": "9",
"answer": [
{
"valueString": "Remler"
}
]
},
{
"linkId": "10",
"answer": [
{
"valueString": "845555349"
}
]
},
{
"linkId": "11",
"answer": [
{
"valueString": "90009"
}
]
},
{
"linkId": "12",
"answer": [
{
"valueString": "Emily"
}
]
},
{
"linkId": "13",
"answer": [
{
"valueString": "Emily"
}
]
},
{
"linkId": "14",
"answer": [
{
"valueCoding": {
"system": "70504",
"code": "19",
"display": "Los Angeles"
}
}
]
},
{
"linkId": "15",
"answer": [
{
"valueCoding": {
"system": "70505",
"code": "CA",
"display": "California"
}
}
]
},
{
"linkId": "16",
"answer": [
{
"valueString": "1A2S3D465G6L8"
}
]
},
{
"linkId": "17",
"answer": [
{
"valueCoding": {
"system": "70507",
"code": "CA",
"display": "California"
}
}
]
},
{
"linkId": "18",
"answer": [
{
"valueString": "Carol"
}
]
},
{
"linkId": "19",
"answer": [
{
"valueCoding": {
"system": "70518",
"code": "1",
"display": "None"
}
}
]
},
{
"linkId": "20",
"answer": [
{
"valueCoding": {
"system": "70519",
"code": "1",
"display": "Yes"
}
}
]
},
{
"linkId": "21",
"answer": [
{
"valueCoding": {
"system": "70530",
"code": "3",
"display": "Barbituates"
}
}
]
},
{
"linkId": "22",
"answer": [
{
"valueString": "Heroin"
}
]
},
{
"linkId": "23",
"answer": [
{
"valueString": "20"
}
]
},
{
"linkId": "24",
"answer": [
{
"valueCoding": {
"system": "70533",
"code": "4",
"display": "Injection (IV or intramuscular)"
}
}
]
},
{
"linkId": "25",
"answer": [
{
"valueCoding": {
"system": "70530",
"code": "6",
"display": "Other Amphetamines"
}
}
]
},
{
"linkId": "26",
"answer": [
{
"valueString": "Methamphetamines"
}
]
},
{
"linkId": "27",
"answer": [
{
"valueString": "10"
}
]
},
{
"linkId": "28",
"answer": [
{
"valueCoding": {
"system": "70533",
"code": "2",
"display": "Smoking"
}
}
]
},
{
"linkId": "29",
"answer": [
{
"valueString": "15"
}
]
},
{
"linkId": "30",
"answer": [
{
"valueString": "26"
}
]
},
{
"linkId": "31",
"answer": [
{
"valueCoding": {
"system": "70545",
"code": "4",
"display": "Unemployed, not in the labor force (not seeking)"
}
}
]
},
{
"linkId": "32",
"answer": [
{
"valueString": "2"
}
]
},
{
"linkId": "33",
"answer": [
{
"valueCoding": {
"system": "70543",
"code": "0",
"display": "No"
}
}
]
},
{
"linkId": "34",
"answer": [
{
"valueCoding": {
"system": "70547",
"code": "0",
"display": "No"
}
}
]
},
{
"linkId": "35",
"answer": [
{
"valueString": "2"
}
]
},
{
"linkId": "36",
"answer": [
{
"valueString": "3"
}
]
},
{
"linkId": "37",
"answer": [
{
"valueString": "0"
}
]
},
{
"linkId": "38",
"answer": [
{
"valueString": "9"
}
]
},
{
"linkId": "39",
"answer": [
{
"valueString": "1"
}
]
},
{
"linkId": "40",
"answer": [
{
"valueString": "2"
}
]
},
{
"linkId": "41",
"answer": [
{
"valueCoding": {
"system": "70564",
"code": "0",
"display": "No"
}
}
]
},
{
"linkId": "42",
"answer": [
{
"valueCoding": {
"system": "70570",
"code": "0",
"display": "No"
}
}
]
},
{
"linkId": "43",
"answer": [
{
"valueCoding": {
"system": "70571",
"code": "0",
"display": "No"
}
}
]
},
{
"linkId": "44",
"answer": [
{
"valueCoding": {
"system": "70572",
"code": "1",
"display": "Yes"
}
}
]
},
{
"linkId": "45",
"answer": [
{
"valueString": "9"
}
]
},
{
"linkId": "46",
"answer": [
{
"valueString": "9"
}
]
},
{
"linkId": "47",
"answer": [
{
"valueCoding": {
"system": "70575",
"code": "1",
"display": "Yes"
}
}
]
},
{
"linkId": "48",
"answer": [
{
"valueString": "2"
}
]
},
{
"linkId": "49",
"answer": [
{
"valueCoding": {
"system": "70578",
"code": "3",
"display": "No"
}
}
]
},
{
"linkId": "50",
"answer": [
{
"valueString": "0"
}
]
},
{
"linkId": "51",
"answer": [
{
"valueString": "5"
}
]
},
{
"linkId": "52",
"answer": [
{
"valueString": "0"
}
]
},
{
"linkId": "53",
"answer": [
{
"valueString": "0"
}
]
},
{
"linkId": "54",
"answer": [
{
"valueString": "0"
}
]
},
{
"linkId": "55",
"answer": [
{
"valueString": "0"
}
]
},
{
"linkId": "56",
"answer": [
{
"valueString": "160785--7--OMA.007"
}
]
}
]
}
}
]
}
QuestionnaireResponse - Cal-OMS Discharge
Client's Cal-OMS Discharge record can be fetched, by using QuestionnaireResponse Search endpoint. There are different parameters available to perform QuestionnaireResponse search. If the Api call is successful, the Status will display a response of “200 OK”, with Discharge information. For failure response http codes, please refer the HTTP Response codes table, for a status and description.
Available searches under QuestionnaireResponse Cal-OMS Discharge
Search QuestionnaireResponse by PatientID
| QueryParameter | R/O | Description | Format |
|---|---|---|---|
| Questionnnaire_type | R | Type | Cal_OMS_Discharge (need to be exact case) |
| Patient | O | PatientID | Integer |
Search QuestionnaireResponse by Cal-OMS Discharge Id
| QueryParameter | R/O | Description | Format |
|---|---|---|---|
| _id | R | Cal-OMS Discharge Identifier | {PATID}--{EpisodeID}--{CalOMSDischargeID} e.g 160785--1--OMD.003 |
Syntax: GET [Base Url]/QuestionnaireResponse/Search?{[QueryParameter=value]}
Search Response
| FHIR Element | AV Field | Description |
|---|---|---|
| QuestionaireResponse | Cal_OMS_Admission | Cal_OMS_Admission |
| Subject Id | PatientID | Patient ID |
| Encounter Id | EncounterID | Encounter ID |
| linkId:4 | Type of Form | Type of Form |
| linkId:1 | Episode ID | Episode ID |
| linkId:5 | Discharge Date | Discharge Date |
| linkId:56 | Associated Cal-OMS Admission | Associated Cal-OMS Admission |
Sample Response Body (Questionnaire Response)
{
"resourceType": "Bundle",
"id": "d7e905ac-4ff4-483a-a7ef-739617a584df",
"meta": {
"lastUpdated": "2023-08-08T20:41:10.498+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://fhirtest.netsmartcloud.com/v4/QuestionnaireResponse?_id=160785--1--OMD.003&page=1"
}
],
"entry": [
{
"fullUrl": "http://fhir-uat-internal.netsmartcloud.com/NtstFhir-web/v4/QuestionnaireResponse/160785--1--OMD.003",
"resource": {
"resourceType": "QuestionnaireResponse",
"id": "160785--1--OMD.003",
"meta": {
"tag": [
{
"code": "Cal-OMS_Discharge",
"display": "Cal-OMS Discharge"
}
]
},
"subject": {
"id": "160785"
},
"authored": "2020-03-02T13:12:00+00:00",
"author": {
"id": "000001"
},
"item": [
{
"linkId": "1",
"answer": [
{
"valueString": "1"
}
]
},
{
"linkId": "3",
"answer": [
{
"valueCoding": {
"system": "70701",
"code": "4",
"display": "Discharge"
}
}
]
},
{
"linkId": "5",
"answer": [
{
"valueString": "2023-06-30"
}
]
},
{
"linkId": "6",
"answer": [
{
"valueCoding": {
"system": "70593",
"code": "1",
"display": "Completed Treatment / Recovery Plan, Goals / Referred/Standard"
}
}
]
},
{
"linkId": "8",
"answer": [
{
"valueString": "Emily"
}
]
},
{
"linkId": "9",
"answer": [
{
"valueString": "Remler"
}
]
},
{
"linkId": "10",
"answer": [
{
"valueString": "845555349"
}
]
},
{
"linkId": "11",
"answer": [
{
"valueString": "90009"
}
]
},
{
"linkId": "12",
"answer": [
{
"valueString": "Emily"
}
]
},
{
"linkId": "13",
"answer": [
{
"valueString": "Emily"
}
]
},
{
"linkId": "14",
"answer": [
{
"valueCoding": {
"system": "70504",
"code": "19",
"display": "Los Angeles"
}
}
]
},
{
"linkId": "15",
"answer": [
{
"valueCoding": {
"system": "70505",
"code": "CA",
"display": "California"
}
}
]
},
{
"linkId": "16",
"answer": [
{
"valueString": "1A2S3D465G6L8"
}
]
},
{
"linkId": "17",
"answer": [
{
"valueCoding": {
"system": "70507",
"code": "CA",
"display": "California"
}
}
]
},
{
"linkId": "18",
"answer": [
{
"valueString": "Carol"
}
]
},
{
"linkId": "19",
"answer": [
{
"valueCoding": {
"system": "70518",
"code": "1",
"display": "None"
}
}
]
},
{
"linkId": "20",
"answer": [
{
"valueCoding": {
"system": "70519",
"code": "1",
"display": "Yes"
}
}
]
},
{
"linkId": "21",
"answer": [
{
"valueCoding": {
"system": "70530",
"code": "3",
"display": "Barbituates"
}
}
]
},
{
"linkId": "22",
"answer": [
{
"valueString": "Heroin"
}
]
},
{
"linkId": "23",
"answer": [
{
"valueString": "20"
}
]
},
{
"linkId": "24",
"answer": [
{
"valueCoding": {
"system": "70533",
"code": "4",
"display": "Injection (IV or intramuscular)"
}
}
]
},
{
"linkId": "25",
"answer": [
{
"valueCoding": {
"system": "70530",
"code": "6",
"display": "Other Amphetamines"
}
}
]
},
{
"linkId": "26",
"answer": [
{
"valueString": "Methamphetamines"
}
]
},
{
"linkId": "27",
"answer": [
{
"valueString": "10"
}
]
},
{
"linkId": "28",
"answer": [
{
"valueCoding": {
"system": "70533",
"code": "2",
"display": "Smoking"
}
}
]
},
{
"linkId": "29",
"answer": [
{
"valueString": "15"
}
]
},
{
"linkId": "30",
"answer": [
{
"valueString": "26"
}
]
},
{
"linkId": "31",
"answer": [
{
"valueCoding": {
"system": "70545",
"code": "4",
"display": "Unemployed, not in the labor force (not seeking)"
}
}
]
},
{
"linkId": "32",
"answer": [
{
"valueString": "2"
}
]
},
{
"linkId": "33",
"answer": [
{
"valueCoding": {
"system": "70543",
"code": "0",
"display": "No"
}
}
]
},
{
"linkId": "34",
"answer": [
{
"valueCoding": {
"system": "70547",
"code": "0",
"display": "No"
}
}
]
},
{
"linkId": "35",
"answer": [
{
"valueString": "2"
}
]
},
{
"linkId": "36",
"answer": [
{
"valueString": "3"
}
]
},
{
"linkId": "37",
"answer": [
{
"valueString": "0"
}
]
},
{
"linkId": "38",
"answer": [
{
"valueString": "9"
}
]
},
{
"linkId": "39",
"answer": [
{
"valueString": "1"
}
]
},
{
"linkId": "40",
"answer": [
{
"valueString": "2"
}
]
},
{
"linkId": "41",
"answer": [
{
"valueCoding": {
"system": "70564",
"code": "0",
"display": "No"
}
}
]
},
{
"linkId": "42",
"answer": [
{
"valueCoding": {
"system": "70570",
"code": "0",
"display": "No"
}
}
]
},
{
"linkId": "43",
"answer": [
{
"valueCoding": {
"system": "70571",
"code": "0",
"display": "No"
}
}
]
},
{
"linkId": "44",
"answer": [
{
"valueCoding": {
"system": "70572",
"code": "1",
"display": "Yes"
}
}
]
},
{
"linkId": "45",
"answer": [
{
"valueString": "9"
}
]
},
{
"linkId": "46",
"answer": [
{
"valueString": "9"
}
]
},
{
"linkId": "47",
"answer": [
{
"valueCoding": {
"system": "70575",
"code": "1",
"display": "Yes"
}
}
]
},
{
"linkId": "48",
"answer": [
{
"valueString": "2"
}
]
},
{
"linkId": "49",
"answer": [
{
"valueCoding": {
"system": "70578",
"code": "3",
"display": "No"
}
}
]
},
{
"linkId": "50",
"answer": [
{
"valueString": "0"
}
]
},
{
"linkId": "51",
"answer": [
{
"valueString": "5"
}
]
},
{
"linkId": "52",
"answer": [
{
"valueString": "0"
}
]
},
{
"linkId": "53",
"answer": [
{
"valueString": "0"
}
]
},
{
"linkId": "54",
"answer": [
{
"valueString": "0"
}
]
},
{
"linkId": "55",
"answer": [
{
"valueString": "0"
}
]
},
{
"linkId": "56",
"answer": [
{
"valueString": "160785--7--OMA.007"
}
]
}
]
}
}
]
}