API
Base Url
https://hidex-portal-uat.azurewebsites.net/
Token API
This endpoint allows the user to get the oauth token by using the clientId and clientSecret. This bearer token would need to be passed to API calls through AUTHORIZATION request header.
Syntax: POST [Base Url]/Token
| Parameter | Description | Type |
|---|---|---|
| clientid | A unique id that is assigned to each provider and used in conjuction with the clientsecret to obtain an oauth token | String |
| clientsecret | A password that is assigned to each clientid and used to obtain an oauth token | String |
Patient API
This endpoint allows the user to add and update patient information. It only accepts the Patient Resource Fhir Json in the request body.
Syntax: POST [Base Url]/patient
Syntax: PUT [Base Url]/patient/{PatientId}
Sample Request Body (Patient PUT)
{
"resourceType": "Patient",
"id": "160785",
"extension": [{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
"valueCodeableConcept": {
"coding": [{
"code": "4"
}]
}
}, {
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/patient-employmentStatus",
"valueCodeableConcept": {
"coding": [{
"code": "2"
}]
}
}, {
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/patient-educationLevel",
"valueCodeableConcept": {
"coding": [{
"code": "3"
}]
}
}],
"identifier": [{
"type": {
"coding": [{
"system": "urn:oid:http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "SS"
}]
},
"system": "http://hl7.org/fhir/sid/us-ssn",
"value": "562-34-5678"
}],
"name": [{
"family": "Doe",
"given": ["Jane", "Mary"]
}],
"telecom": [{
"system": "phone",
"value": "555-354-5555",
"use": "home"
}, {
"system": "email",
"value": "test@test.com",
"use": "mobile"
}],
"gender": "female",
"birthDate": "1988-08-25",
"address": [{
"use": "home",
"line": ["1000 S. Fremont", "Suite 500"],
"city": "Alhambra",
"district": "19",
"state": "CA",
"postalCode": "91803"
}],
"maritalStatus": {
"coding": [{
"system": "http://hl7.org/fhir/ValueSet/marital-status",
"code": "2"
}]
},
"communication": [{
"language": {
"coding": [{
"system": "urn:ietf:bcp:47",
"code": "7"
}]
}
}]
}
Observation API
This endpoint allows the user to add and update patient's smoking status information. It only accepts the Observation Resource Fhir Json in the request body.
Syntax: POST [Base Url]/observation
Syntax: PUT [Base Url]/observation/{ObservationId}
Sample Request Body (Observation PUT)
{
"resourceType": "Observation",
"id": "social-history_121250--MPI67037.001",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"
]
},
"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": {
"id": "121250",
"reference": "Patient/121250"
},
"effectiveDateTime": "2019-10-15T05:00:00-07:00",
"valueCodeableConcept": {
"coding": [
{
"code": "2",
"display": "Former Smoker"
}
]
}
}
Encounter API
This endpoint allows the user to add and update encounter information. It only accepts the Encounter Resource Fhir Json in the request body.
Syntax: POST [Base Url]/encounter
Syntax: PUT [Base Url]/encounter/{EncounterId}
Sample Request Body (Encounter PUT)
{
"resourceType": "Encounter",
"id": "160785--6648.51",
"extension": [{
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/encounter-hospitalServiceReference",
"valueReference": {
"id": "LE11800"
}
}],
"status": "arrived",
"class": {
"system": "44",
"code": "1"
},
"subject": {
"id": "160785"
},
"participant": [{
"individual": {
"id": "002683"
}
}],
"period": {
"start": "2023-01-11T13:48:00+00:00"
}
}
Condition API
This endpoint allows the user to add and update condition (Women's Health History & Diagnosis) information. It only accepts the Condition Resource Fhir Json in the request body.
Syntax: POST [Base Url]/condition
Syntax: PUT [Base Url]/condition/{ConditionId}
Sample Request Body (Condition-Diagnosis PUT)
{
"resourceType": "Condition",
"id": "91141--293847",
"extension": [{
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/condition-diagnosisRole",
"valueCodeableConcept": {
"coding": [{
"code": "A"
}]
}
}, {
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/condition-diagnosisRank",
"valueCodeableConcept": {
"coding": [{
"code": "1"
}]
}
}, {
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/condition-diagnosisBillOrder",
"valueInteger": 1
}],
"identifier": [{
"value": "Diagnosis"
}],
"clinicalStatus": {
"coding": [{
"code": "4"
}]
},
"code": {
"coding": [{
"system": "urn:oid:2.16.840.1.113883.6.90",
"code": "A92.5"
}]
},
"subject": {
"id": "160785"
},
"encounter": {
"id": "160785--6648.51"
},
"onsetDateTime": "2023-08-04T02:57:23+00:00",
"abatementDateTime": "2023-08-11T02:57:23+00:00",
"asserter": {
"id": "1"
}
}
Sample Request Body (Condition-Womens Health History PUT)
{
"resourceType": "Condition",
"id": "1--160785--PRG.018",
"identifier": [{
"value": "Womens Health History"
}],
"code": {
"coding": [{
"display": "Pregnancy Status"
}]
},
"subject": {
"id": "160785",
},
"encounter": {
"id": "160785--6648.52",
},
"onsetDateTime": "2022-11-12",
"abatementDateTime": "2023-08-12",
"recordedDate": "2023-08-12"
}
Coverage API
This endpoint allows the user to add and update coverage information. It only accepts the Coverage Resource Fhir Json in the request body.
Syntax: POST [Base Url]/coverage
Syntax: PUT [Base Url]/coverage/{CoverageId}
Sample Request Body (Coverage POST)
{
"resourceType": "Coverage",
"extension": [{
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/coverage-birth-date",
"valueString": "1988-08-25"
}, {
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/coverage-gender",
"valueCodeableConcept": {
"coding": [{
"code": "M"
}]
}
}, {
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/coverage-bill-order",
"valueInteger": 1
}, {
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/coverage-address",
"valueAddress": {
"line": ["123 Main Street", "Apt 123"],
"city": "Westwood",
"state": "CA",
"postalCode": "90028"
}
}, {
"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"
}
}],
"policyHolder": {
"id": "121250"
},
"period": {
"start": "2023-07-27",
"end": "2023-08-11"
},
"network": "2"
}
Bundle API
This endpoint allows the user to add and update patient information based on supported workflow. It only accepts the Bundle Resource Fhir Json in the request body.
Below is the list of supported workflow:
| Workflow | Supported FHIR Resource | Resource Type |
|---|---|---|
| Admit Existing Client | Patient, Encounter | Bundle |
| Admit Existing Client + Diagnosis | Patient, Encounter, Condition | Bundle |
| Admit Existing Client + Women’s Health History | Patient, Encounter, Condition | Bundle |
| Admit Existing Client + Client Financial Eligibility | Patient, Encounter, Coverage | Bundle |
| Admit Existing Client + Cal-OMS Admission | Patient, Encounter, QuestionnaireResponse | Bundle |
| Admit Existing Client + Cal-OMS Discharge | Patient, Encounter, QuestionnaireResponse | Bundle |
Syntax: POST [Base Url]/bundle
Sample Request Body (Bundle)
{
"resourceType": "Bundle",
"id": "545ba737-b682-42be-a1f1-839434894e5e",
"meta": {
"lastUpdated": "2023-06-13T23:36:55.473+00:00"
},
"type": "searchset",
"total": 5,
"link": [{
"relation": "self",
"url": "https://fhirtest.netsmartcloud.com/v4/Condition?patient=160785&start=1800-01-01&category=encounter-diagnosis&page=1"
}],
"entry": [{
"fullUrl": "https://fhirtest.netsmartcloud.com/v4/Patient/160785",
"resource": {
"resourceType": "Patient",
"id": "160785",
"extension": [{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
"valueCodeableConcept": {
"coding": [{
"code": "4"
}]
}
}, {
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/patient-employmentStatus",
"valueCodeableConcept": {
"coding": [{
"code": "2"
}]
}
}, {
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/patient-educationLevel",
"valueCodeableConcept": {
"coding": [{
"code": "3"
}]
}
}],
"identifier": [{
"type": {
"coding": [{
"system": "urn:oid:http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "SS"
}]
},
"system": "http://hl7.org/fhir/sid/us-ssn",
"value": "562-34-5678"
}],
"name": [{
"family": "Doe",
"given": ["Jane", "Mary"]
}],
"telecom": [{
"system": "phone",
"value": "555-354-5555",
"use": "home"
}, {
"system": "email",
"value": "test@test.com",
"use": "mobile"
}],
"gender": "female",
"birthDate": "1988-08-25",
"address": [{
"use": "home",
"line": ["1000 S. Fremont", "Suite 500"],
"city": "Alhambra",
"district": "19",
"state": "CA",
"postalCode": "91803"
}],
"maritalStatus": {
"coding": [{
"system": "http://hl7.org/fhir/ValueSet/marital-status",
"code": "2"
}]
},
"communication": [{
"language": {
"coding": [{
"system": "urn:ietf:bcp:47",
"code": "7"
}]
}
}]
},
"request": {
"method": "PUT",
"url": ""
}
},
{
"fullUrl": "https://fhirtest.netsmartcloud.com/v4/Encounter/160785--6648.51",
"resource": {
"resourceType": "Encounter",
"id": "160785--6648.51",
"extension": [{
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/encounter-hospitalServiceReference",
"valueReference": {
"id": "LE11800"
}
}],
"status": "arrived",
"class": [{
"code": "1",
"display": "Admission",
"system": "44"
}],
"subject": {
"id": "160785"
},
"participant": [{
"individual": {
"id": "000001"
}
}],
"period": {
"start": "2023-01-11T10:48:00+00:00"
}
},
"request": {
"method": "PUT",
"url": ""
}
},
{
"fullUrl": "https://fhirtest.netsmartcloud.com/v4/Condition/91141--293847",
"resource": {
"resourceType": "Condition",
"id": "91141--293847",
"extension": [{
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/condition-diagnosisRole",
"valueCodeableConcept": {
"coding": [{
"code": "A"
}]
}
}, {
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/condition-diagnosisRank",
"valueCodeableConcept": {
"coding": [{
"code": "1"
}]
}
}, {
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/condition-diagnosisBillOrder",
"valueInteger": 1
}],
"identifier": [{
"value": "Diagnosis"
}],
"clinicalStatus": {
"coding": [{
"code": "4"
}]
},
"code": {
"coding": [{
"system": "urn:oid:2.16.840.1.113883.6.90",
"code": "A92.5"
}]
},
"subject": {
"id": "160785"
},
"encounter": {
"id": "160785--6648.51"
},
"onsetDateTime": "2023-08-04T02:57:23+00:00",
"abatementDateTime": "2023-08-11T02:57:23+00:00",
"asserter": {
"id": "1"
}
},
"request": {
"method": "PUT",
"url": ""
}
},
{
"fullUrl": "https://fhirtest.netsmartcloud.com/v4/Condition/1--160785--PRG.018",
"resource": {
"resourceType": "Condition",
"id": "1--160785--PRG.018",
"identifier": [{
"value": "Womens Health History"
}],
"code": {
"coding": [{
"display": "Pregnancy Status"
}]
},
"subject": {
"id": "160785"
},
"encounter": {
"id": "160785--6648.52"
},
"onsetDateTime": "2022-11-12",
"abatementDateTime": "2023-08-12",
"recordedDate": "2023-08-12"
},
"request": {
"method": "PUT",
"url": ""
}
},
{
"fullUrl": "https://fhirtest.netsmartcloud.com/v4/Coverage",
"resource": {
"resourceType": "Coverage",
"extension": [{
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/coverage-birth-date",
"valueString": "1988-08-25"
}, {
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/coverage-gender",
"valueCodeableConcept": {
"coding": [{
"code": "M"
}]
}
}, {
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/coverage-address",
"valueAddress": {
"line": ["123 Main Street", "Apt 123"],
"city": "Westwood",
"state": "CA",
"postalCode": "90028"
}
}, {
"url": "https://fhirtest.netsmartcloud.com/v4/StructureDefinition/coverage-social-security-number",
"valueString": "999-99-9999"
}],
"policyHolder": {
"id": "160785"
},
"period": {
"start": "2023-07-27",
"end": "2023-08-11"
},
"network": "2"
},
"request": {
"method": "POST",
"url": ""
}
}
]
}