HIDEX Portal

Use Case & Service Operations

Core Resources

Resource Types
Patient
Observation (Smoking Status)
Encounter
Condition (Women’s Health History)
Condition (Diagnosis)
Coverage (Client Financial Eligibility)
EpisodeOfCare

Patient (Client Data)

Description

The Provider may create or update any of the demographic or other administrative information about a patient. To retrieve any demographic data or other administrative information about a patient the Provider can use the Get Patient API.

GET Patient Resource - Input

URL Parameter Description Format
{PatientID} Patient ID {PATID}
e.g 160785
Example: https://hidex-portal-uat.azurewebsites.net/api/patient/160785

GET Patient Resource - Output

FHIR Element AV Field Description
id Client Number Unique Identifier
extension: patient-custom-race Race Race
e.g Asian Native, American
extension: patient-custom-ethnicity Ethnicity Ethnicity
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
extension: patient-veteran-status Veteran Patient’s Veteran Level
gender Sex Patient’s Gender
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
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: "phone"
telecom.use: "mobile"
telecom.value 		Client's Mobile Phone Patient’s Mobile 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
address.postalcode Client's Address - Zipcode Patient’s Address - Zipcode
address.Period.Start
address.Period.End		 Stay period in UTC
photo Photo url
maritalStatus.coding.code Marital Status Patient’s Marital Status
communication.language.coding.code Primary Language Patient’s Primary Language

POST Patient Resource - Input

JSON Sample Generator: https://hidex-portal-uat.azurewebsites.net/Core/Patient/Create

FHIR Resource FHIR Attribute PCNX Field R/O/C/R Validation MaxL
Patient name.family Client First Name R Free Text 20
Patient name.given Client Last Name R Free Text 20
Patient name.given Client Middle Name O Free Text 20
Patient identifier Social Security Number O ###-##-####
Patient birthDate Date of Birth O YYYY-MM-DD
Patient Extension: patient-custom-race Race O Restricted to a set of values provided via Data Dictionary. Please refer to this link 2
Patient extension:patient-genderIdentity Sex R Restricted to a set of values provided via Data Dictionary. Please refer to this link 7
Patient Extension: us-core-genderIdentity Gender Identity O Restricted to a set of values provided via Data Dictionary. Please refer to this link
Patient Extension:us-core-ethnicity Ethnicity O Restricted to a set of values provided via Data Dictionary. Please refer to this link 2
Patient Extension:patient-employmentStatus Employment Status O Restricted to a set of values provided via Data Dictionary. Please refer to this link 2
Patient Extension:patient-educationLevel Education Level O Restricted to a set of values provided via Data Dictionary. Please refer to this link 2
Patient Extension:patient-sexualOrientation Sexual Orientation O Restricted to a set of values provided via Data Dictionary. Please refer to this link
Patient telecom.system: "phone"
telecom.use: "home" 		Clients Home Phone O ###-###-####
Patient telecom.system: "phone"
telecom.use: "work" 		Clients Work Phone O ###-###-####
Patient telecom.system: "phone"
telecom.use: "mobile" 		Clients Mobile Phone O ###-###-####
Patient telecom.system: "email"
telecom.use: "mobile" 		Email O Free Text 40
Patient marital status Marital status O Restricted to a set of values provided via Data Dictionary. Please refer to this link 1
Patient communication Clients Primary Language O Restricted to a set of values provided via Data Dictionary. Please refer to this link 1
Patient address.line Street Address 1 O Free Text 40
Patient address.line Street Address 2 O Free Text 40
Patient address.city City O Free Text 40
Patient address.state State O Restricted to a set of values provided via Data Dictionary. Please refer to this link 2
Patient address.district County O Restricted to a set of values provided via Data Dictionary. Please refer to this link 2
Patient address.postalcode ZipCode O ##### or #####-####

POST Patient Resource - Output

Data Attribute
Client Id

PUT Patient Resource - Input

JSON Sample Generator: https://hidex-portal-uat.azurewebsites.net/Core/Patient/Update

FHIR Resource FHIR Attribute PCNX Field R/O/C/R Validation MaxL
Patient subject Client Number R {PATID} 9
Patient name.family Client First Name R Free Text 20
Patient name.given Client Last Name R Free Text 20
Patient name.given Client Middle Name O Free Text 20
Patient identifier Social Security Number O ###-##-####
Patient birthDate Date of Birth O YYYY-MM-DD
Patient Extension:us-core-ethnicity Ethnicity O Restricted to a set of values provided via Data Dictionary. Please refer to this link 2
Patient Extension: patient-custom-race Race O Restricted to a set of values provided via Data Dictionary. Please refer to this link 2
Patient extension:patient-genderIdentity Sex R Restricted to a set of values provided via Data Dictionary. Please refer to this link 7
Patient Extension: us-core-genderIdentity Gender Identity O Restricted to a set of values provided via Data Dictionary. Please refer to this link
Patient Extension:patient-employmentStatus Employment Status O Restricted to a set of values provided via Data Dictionary. Please refer to this link 2
Patient Extension:patient-educationLevel Education Level O Restricted to a set of values provided via Data Dictionary. Please refer to this link 2
Patient Extension:patient-sexualOrientation Sexual Orientation O Restricted to a set of values provided via Data Dictionary. Please refer to this link
Patient telecom.system: "phone"
telecom.use: "home" 		Clients Home Phone O ###-###-####
Patient telecom.system: "phone"
telecom.use: "work" 		Clients Work Phone O ###-###-####
Patient telecom.system: "phone"
telecom.use: "mobile" 		Clients Mobile Phone O ###-###-####
Patient telecom.system: "email"
telecom.use: "mobile" 		Email O Free Text 40
Patient marital status Marital status O Restricted to a set of values provided via Data Dictionary. Please refer to this link 1
Patient communication Clients Primary Language O Restricted to a set of values provided via Data Dictionary. Please refer to this link 1
Patient address.line Street Address 1 O Free Text 40
Patient address.line Street Address 2 O Free Text 40
Patient address.city City O Free Text 40
Patient address.state State O Restricted to a set of values provided via Data Dictionary. Please refer to this link 2
Patient address.district County O Restricted to a set of values provided via Data Dictionary. Please refer to this link 2
Patient address.postalcode ZipCode O ##### or #####-####

PUT Patient Resource - Output

Data Attribute
Client Id

Observation (Smoking Status)

Description

The Provider may create or update smoking information about a patient. To retrieve smoking information about a patient the Provider can use the Get Observation API.

GET Observation Resource - Input

URL Parameter Description Format
{ObservationID} Observation ID social-history_{PATID--ObservationID}
e.g social-history_160785--MPI67039.002
Example: https://hidex-portal-uat.azurewebsites.net/api/observation/social-history_160785--MPI67039.002

GET Observation Resource - Output

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

POST Observation Resource - Input

FHIR Resource FHIR Attribute PCNX Field R/O/CR Validation MaxL
Observation category R Category.coding.code must be in exact case 'social-history'
Observation subject Client Number R {PATID} 9
Observation effectiveDateTime Smoker Status Assessment Date R
Observation valueCodeableConcept Smoker R Restricted to a set of values provided via Provider Directory 2

POST Observation Resource - Output

Data Attribute
Observation ID

PUT Observation Resource - Input

FHIR Resource FHIR Attribute PCNX Field R/O/CR Validation MaxL
Observation Observation Id R social-history_{PATID--ObservationID}
e.g social-history_160785--MPI67039.002
Observation category R Category.coding.code must be in exact case 'social-history'
Observation subject Client Number R {PATID} 9
Observation effectiveDateTime Smoker Status Assessment Date O
Observation valueCodeableConcept Smoker R Restricted to a set of values provided via Provider Directory 2

PUT Observation Resource - Output

Data Attribute
Observation ID

Encounter (Admit Existing Client)

Description

The Provider may create or update any interaction between them and a patient.

GET Encounter Resource - Input

URL Parameter Description Format
{EncounterID} Encounter ID {PatID--EncounterID}
e.g 160785--6648.51
Example: https://hidex-portal-uat.azurewebsites.net/api/encounter/160785--6648.51

GET Encounter Resource - Output

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

POST Encounter Resource - Input

JSON Sample Generator: https://hidex-portal-uat.azurewebsites.net/Core/Encounter/Create

FHIR Resource FHIR Attribute PCNX Field R/O/CR Validation MaxL
Encounter Subject Client Number R {PATID} 9
Encounter Participant Practitioner ID R Restricted to a set of values provided via Provider Directory 6
Encounter Extension:encounter-hospitalServiceReference Program R Restricted to a set of values provided via Provider Directory 10
Encounter Class Type of Admission R Restricted to a set of values provided via Data Dictionary. Please refer to this link 1
Encounter Period.start Admission DateTime R YYYY-MM-DDTHH:MM:SS-07:00 *UTC Timezone can be -07 or -06 based on Daylight Saving

POST Encounter Resource - Output

Data Attribute
Encounter ID

PUT Encounter Resource - Input

JSON Sample Generator: https://hidex-portal-uat.azurewebsites.net/Core/Encounter/Update

FHIR Resource FHIR Attribute PCNX Field R/O/CR Validation MaxL
Encounter Encounter ID R {PATID}--{EncounterID}
Encounter Subject Client Number R {PATID} 9
Encounter Participant Practitioner ID O Restricted to a set of values provided via Provider Directory 6
Encounter Extension:encounter-hospitalServiceReference Program R Restricted to a set of values provided via Provider Directory 10
Encounter Class Type of Admission R Restricted to a set of values provided via Data Dictionary. Please refer to this link 1
Encounter Period.start Admission DateTime O YYYY-MM-DDTHH:MM:SS-07:00 *UTC Timezone can be -07 or -06 based on Daylight Saving
Date under Period field and Program field can't be updated using a PUT API call. Period field value is combination and Date and Time. Date can't be changed but Time can be changed. Changing Period field's time zone value may cause an error if the date is changed, as a result of time zone change.

For e.g in date "2023-08-04T02:57:23-07:00", value "-07:00" represents time zone. Changing that to non-zero value may change the date to next day.

PUT Encounter Resource - Output

Data Attribute
Encounter ID

Condition (Women's Health History)

Description

The Provider may create or update a Women’s Health History form in a Client’s profile to add, view or modify information pertaining to client’s health record. To retrieve any Women’s Health History data for a patient the Provider can use the Get Condition API.

GET Condition (Women’s Health History) – Input

URL Parameter Description Format
{PregnancyID} Pregnancy Identifier pregnancy_1--{PATID}--{PregnancyID}
e.g pregnancy_1--160785--PRG.001
Example: https://hidex-portal-uat.azurewebsites.net/api/condition/pregnancy_1--160785--PRG.001

GET Condition (Women’s Health History) – Output

FHIR Element AV Field Description
id Pregnancy Unique Record ID Pregnancy Unique Record ID
category.coding FHIR Condition Category
code.coding LOINC Pregnancy Status - Reported
subject.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

POST Condition (Women’s Health History) – Input

JSON Sample Generator: https://hidex-portal-uat.azurewebsites.net/Bundles/WomensHealthHistory/Create

FHIR Resource FHIR Attribute PCNX Field R/O/CR Validation MaxL
Condition Subject Client Number R {PATID} 9
Condition Encounter R {PATID}--{EncounterID}
Condition Identifier R Must be in exact case ‘Womens Health History’
Condition onsetDateTime Pregnancy Start Date O YYYY-MM-DD
Condition Abatementdatetime Pregnancy End Date O YYYY-MM-DD
Condition recordedDate Assessment Date R YYYY-MM-DD
Condition Code R Code.Coding.Display must be in exact case ‘Pregnancy Status’

POST Condition (Women’s Health History) – Output

Data Attribute
Pregnancy ID

PUT Condition (Women’s Health History) – Input

JSON Sample Generator: https://hidex-portal-uat.azurewebsites.net/Bundles/WomensHealthHistory/Update

FHIR Resource FHIR Attribute PCNX Field R/O/CR Validation MaxL
Condition PregnancyID R pregnancy_1--{PATID}--{PregnancyID}
e.g pregnancy_1--160785--PRG.001
Condition Subject Client Number R {PATID} 9
Condition Encounter R {PATID}--{EncounterID}
Condition Identifier R Must be in exact case ‘Womens Health History’
Condition onsetDateTime Pregnancy State Date O YYYY-MM-DD
Condition Abatementdatetime Pregnancy End Date O YYYY-MM-DD
Condition recordedDate Assessment Date O YYYY-MM-DD
Condition Code R Code.Coding.Display must be in exact case ‘Pregnancy Status’

PUT Condition (Women’s Health History) – Output

Data Attribute
Pregnancy ID

Condition (Provider Diagnosis ICD-10)

Description

The Provider may create or update a Provider Diagnosis ICD-10 form in a Client’s profile to add, view or modify information pertaining to client’s health record. To retrieve any Provider Diagnosis ICD-10 data for a patient the Provider can use the Get Condition API.

GET Condition (Provider Diagnosis ICD-10) – Input

URL Parameter Description Format
{DiagnosisID} Diagnosis Identifier Encounter-diagnosis_{DiagnosisID}
e.g encounter-diagnosis_90832--293439
Example: https://hidex-portal-uat.azurewebsites.net/api/condition/encounter-diagnosis_90832--293439

GET Condition (Provider Diagnosis ICD-10) – Output

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)

POST Condition (Provider Diagnosis ICD-10) – Input

Sample JSON Generator: https://hidex-portal-uat.azurewebsites.net/Bundles/Diagnosis/Create

FHIR Resource FHIR Attribute PCNX Field R/O/C/R Validation MaxL
Condition Subject Client Number R {PATID} 9
Condition Encounter ID R {PATID}--{EncounterID}
Condition Identifier R Must be in exact case ‘Diagnosis’
Condition Extension:condition-diagnosisBillOrder Bill Order R Numeric 5
Condition Extension: condition-diagnosisRank Ranking R Restricted to a set of values provided via Data Dictionary. Please refer to this link 1
Condition Extension: condition-diagnosisRole Type of Diagnosis O Restricted to a set of values provided via Data Dictionary. Please refer to this link 1
Condition ClinicalStatus Status O Restricted to a set of values provided via Data Dictionary. Please refer to this link 1
Condition Code.coding.code Diagnosis R ICD-10 Diagnosis Code
Condition OnsetDateTime Date of Diagnosis
Time of Diagnosis 		O YYYY-MM-DDTHH:MM:SS-07:00 *UTC Timezone can be -07 or -06 based on Daylight Saving
Condition AbatementDateTime Resolved date O

YYYY-MM-DDTHH:MM:SS-07:00 *UTC Timezone can be -07 or -06 based on Daylight Saving

*ONLY required if ClinicalStatus value is '4 - Resolved'
Condition Asserter Diagnosing Practitioner R Restricted to a set of values provided via Provider Directory 6

POST Condition (Provider Diagnosis ICD-10) - Output

Data Attribute
Diagnosis ID

PUT Condition (Provider Diagnosis ICD-10) – Input

Sample JSON Generator: https://hidex-portal-uat.azurewebsites.net/Bundles/Diagnosis/Update

FHIR Resource FHIR Attribute PCNX Field R/O/CR Validation MaxL
Condition Diagnosis ID R {DiagnosisID}
Condition Subject Client Number R {PATID} 9
Condition Encounter R {PATID}--{EncounterID}
Condition Identifier R Must be in exact case ‘Diagnosis’
Condition Extension:condition-diagnosisBillOrder Bill Order R Numeric 5
Condition Extension: condition-diagnosisRank Diagnosis Rank R Restricted to a set of values provided via Data Dictionary. Please refer to this link 1
Condition Extension: condition-diagnosisRole Type of Diagnosis O Restricted to a set of values provided via Data Dictionary. Please refer to this link 1
Condition ClinicalStatus Status O Restricted to a set of values provided via Data Dictionary. Please refer to this link 1
Condition Code.coding.code Diagnosis R ICD-10 Diagnosis Code
Condition OnsetDateTime Date of Diagnosis
Time of Diagnosis 		O YYYY-MM-DDTHH:MM:SS-07:00 *UTC Timezone can be -07 or -06 based on Daylight Saving
Condition AbatementDateTime Resolved Date O

YYYY-MM-DDTHH:MM:SS-07:00 *UTC Timezone can be -07 or -06 based on Daylight Saving

*ONLY required if ClinicalStatus value is '4 - Resolved'
Condition Asserter Diagnosing Practitioner R Restricted to a set of values provided via Provider Directory 6
Date of Diagnosis/Resolved date fields can't be updated in a PUT API call. The field value is combination of Date and Time. Date can't be changed but Time can be changed. Changing Date of Diagnosis's/Resolved date's time zone value may cause an error if the date is changed, as a result of time zone change.

For e.g in date "2023-08-04T02:57:23-07:00", value "-07:00" represents time zone. Changing that to non-zero value may change the date to next day.

PUT Condition (Provider Diagnosis ICD-10) - Output

Data Attribute
Diagnosis ID

Coverage (Client Financial Eligibility)

Description

The Provider needs to access the Financial Eligibility form in a Client’s profile to add or modify Medical Insurance information to it. To retrieve any Financial Eligibility data for a patient the Provider can use the Get Coverage API.

GET Coverage Resource – Input

URL Parameter Description Format
{CoverageID} Coverage Identifier {PATID}--{CoverageID}--PATIENT
e.g 160785--S109.001--PATIENT
Example: https://hidex-portal-uat.azurewebsites.net/api/coverage/160785--S109.001--PATIENT

GET Coverage Resource – Output

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's Sex Subscriber's Sex
extension: coverage-relationship-code Client's Relationship To Subscriber Client's Relationship To Subscriber
extension: coverage-address
valueAddress.line 		Subscriber's Address - Street Line 1 Subscriber's Address - Street Line 1
extension: coverage-address
valueAddress.line 		Subscriber's Address - Street Line 2 Subscriber's Address - Street Line 2
extension: coverage-address
valueAddress.city 		Subscriber's Address - City Subscriber's Address - City
extension: coverage-address
valueAddress.district 		Subscriber's Address - County Subscriber's Address - County
extension: coverage-address
valueAddress.state 		Subscriber's Address - State Subscriber's Address - State
extension: coverage-address
valueAddress.postalCode 		Subscriber's Address - Zip Subscriber's 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.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-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
beneficiary.reference Client Number Client Number
relationship.coding.code Client's Relationship To Subscriber Client's Relationship To Subscriber
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 #

POST Coverage Resource – Input

JSON Sample Generator: https://hidex-portal-uat.azurewebsites.net/Core/Coverage/Create

FHIR Resource FHIR Attribute PCNX Field R/O/CR Validation MaxL
Coverage PolicyHolder Client Number R {PATID} 6
Coverage Network Guarantor ID R Restricted to a set of values provided via Data Dictionary. Please refer to this link 3
Coverage Period.start Coverage Effective Date R YYYY-MM-DD
Coverage Period.end Coverage End Date O YYYY-MM-DD
Coverage Extension: coverage-birth-date Subscriber's Birth Date O YYYY-MM-DD
Coverage Extension: coverage-gender Subscriber's Sex O Restricted to a set of values provided via Data Dictionary. Please refer to this link 1
Coverage Extension: coverage-bill-order Bill Order O Numeric 5
Coverage Extension: coverage-address
valueAddress.line 		Subscriber's Address - Street Line 1 O Free text 50
Coverage Extension: coverage-address
valueAddress.line 		Subscriber's Address - Street Line 2 O Free text 50
Coverage Extension: coverage-address
valueAddress.city 		Subscriber's Address - City O Free text 100
Coverage Extension: coverage-address
valueAddress.district 		Subscriber's Address - County O Free text 2
Coverage Extension: coverage-address
valueAddress.state 		Subscriber's Address - State O Free text 2
Coverage Extension: coverage-address
valueAddress.postalCode 		Subscriber's Address - Zip O Free text
Coverage Extension: coverage-subscriber-name
valueHumanName.name.given		 Subscriber's First Name O Free text 20
Coverage Extension: coverage-subscriber-name
valueHumanName.name.family		 Subscriber's Last Name O Free text 20
Coverage Extension: coverage-social-security-number Subscriber's Social Security # O ###-##-####
Coverage Extension: coverage-encounterReference R {PATID}--{EncounterID}

POST Coverage Resource - Output

Data Attribute
Coverage ID

PUT Coverage Resource – Input

JSON Sample Generator: https://hidex-portal-uat.azurewebsites.net/Core/Coverage/Update

FHIR Resource FHIR Attribute PCNX Field R/O/CR Validation MaxL
Coverage CoverageID R {PATID}--{CoverageID}--PATIENT 6
Coverage PolicyHolder Client Number R {PATID} 6
Coverage Period.start Coverage Effective Date O YYYY-MM-DD
Coverage Period.end Coverage End Date O YYYY-MM-DD
Coverage Extension: coverage-birth-date Subscriber's Birth Date O YYYY-MM-DD
Coverage Extension: coverage-gender Subscriber's Sex O Restricted to a set of values provided via Data Dictionary. Please refer to this link 1
Coverage Extension: coverage-bill-order Bill Order O Numeric 5
Coverage Extension: coverage-address
valueAddress.line 		Subscriber's Address - Street Line 1 O Free text 50
Coverage Extension: coverage-address
valueAddress.line 		Subscriber's Address - Street Line 2 O Free text 50
Coverage Extension: coverage-address
valueAddress.city 		Subscriber's Address - City O Free text 100
Coverage Extension: coverage-address
valueAddress.district 		Subscriber's Address - County O Free text 2
Coverage Extension: coverage-address
valueAddress.state 		Subscriber's Address - State O Free text 2
Coverage Extension: coverage-address
valueAddress.postalCode 		Subscriber's Address - Zip O Free text
Coverage Extension: coverage-subscriber-name
valueHumanName.name.given		 Subscriber's First Name O Free text 20
Coverage Extension: coverage-subscriber-name
valueHumanName.name.family		 Subscriber's Last Name O Free text 20
Coverage Extension: coverage-social-security-number Subscriber's Social Security # O ###-##-####
Coverage Extension: coverage-encounterReference R {PATID}--{EncounterID}

PUT Coverage Resource - Output

Data Attribute
Coverage ID

EpisodeOfCare

Description

The provider may create a EpisodeOfCare for a client and record all the encounters under a given Episode. To retrieve all Episode information provider can use the Get EpisodeOfCare API.

GET EpisodeOfCare Resource – Input

URL Parameter Description Format
{EpisodeID} EpisodeOfCare Identifier {PATID}--{EpisodeID}
e.g 160785--1
Example: https://hidex-portal-uat.azurewebsites.net/api/EpisodeOfCare/160785--1

GET EpisodeOfCare Resource – Output

FHIR Element PCNX Field Description
id EpisodeOfCareID
status Episode Status
type.coding.code Episode Type
type.coding.system Program Encounter Program
diagnosis.condition.reference ConditionID
diagnosis.role.coding.system
diagnosis.role.coding.code 		Condition Diagnosis Role
patient.reference Client Number Client Number
period.start
period.end 		Admission DateTime Encounter Period