Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Current »

The following data structure can be used to share intervention information to other organizations. For purposes of this document, an intervention is assistance or any service provided to a community member to partially or fully meet an identified need. There can be multiple interventions for each community member. Note that we are using the term Patient to identify person being referred or consuming the service, but in cases of social services, it is any community member whether they are a patient of a health care provider or not.

Column

Description

Required

event

The event represents the type of transaction that occured in the system for this information to be saved.

procedure_basedOn_0_serviceRequestId

The CIE Hub Service Request ID. This is the ID that is passed from the Hub when the referral is initially created. This will connect the intervention with the corresponding referral.

procedure_subject_patientId

The CIE Hub Patient Id. This is the unique identifier that ties together all the information about the patient in the hub. This will be used, in this file, to connect the intervention(s) with the Patient.

procedure_code_coding_0_code

Identification of the intervention that was given to the patient using a coding system. This represents the code. For example, a Gravity intervention code such as I-113, Provision of Food Voucher.

procedure_code_coding_0_display

Identification of the intervention that was given to the patient using a coding system. This represents the human readable display of that code.

procedure_code_coding_0_system

Identification of the intervention that was given to the patient using a coding system. This represents the system of the code. (for example, LOINC or Gravity)

procedure_code_text

Free text that can be added to futher describe the type of intervention that took place.

procedure_category_coding_0_code

Classification or metadata code associated with the intervention using a coding system.

procedure_category_coding_0_display

Classification or metadata associated with the intervention using a coding system. This represents the human readable text.

procedure_category_coding_0_system

Classification or metadata associated with the intervention using a coding system. This represents the system of the code. (for example, LOINC or Gravity)

procedure_note_0_text

The text of a note that is associated with the Intervention.

procedure_identifier_0_system

The next three items will allow the client that is submitting the information to provide their own identifier. For example if the intervention was a ride and you had a id associated with the ride record you could pass it over and the CIE Hub would associated that record in the hub with client’s identifier. This value is a uri. For this example it would be your companies uri.

Here is a link to FHIR Spec

https://www.hl7.org/fhir/datatypes-definitions.html#Identifier.system

procedure_identifier_0_use

Represents the use of this client’s identifier would be one of the following values.

usual | official | temp | secondary | old

This should default to official.

procedure_identifier_0_value

Your value of the identifier.

procedure_identifier_0_type

A text representation of the what the identifier represents.

procedure_note_0_time

The time and date of the creation of the note

procedure_note_0_author_reference_display

The name of the author of the note.

procedure_recorder_display

The name of the system, organization, or person that recorded this intervention

procedure_performed_dateTime

The date and time the intervention took place

procedure_extension_pickup_address

For transportation interventions this is the pickup location.

procedure_extension_dropoff_address

For transportation interventions this is the dropoff location.

procedure_extension_distance

For transportation interventions this is the distance of the ride. The distance is in miles.

procedure_extension_duration

For transportation interventions this is the duration of the ride. The duration is in minutes.

procedure_extension_ride_cost

For transportation interventions this is the cost of the ride. The cost is in US dollars.

patient_identifier_0_system

The next three items will allow the client that is submitting the information to provide their own identifier for the patient that received the service. This value is a uri. For this example it would be your companies uri. For example

http://clientcompanyname.org

Here is a link to FHIR Spec

https://www.hl7.org/fhir/datatypes-definitions.html#Identifier.system

patient_identifier_0_use

Represents the use of this identifier would be one of the following values.

usual | official | temp | secondary | old

This should be defaulted to official.

patient_identifier_0_value

Your value of the client’s patient identifier.

patient_identifier_0_type

A text representation of the what the identifier represents.

patient_name_given

The given name of the patient.

*only needed if CIE patient does not exist.

patient_name_family

The family name of the patient.

*only needed if CIE patient does not exist.

patient_name_middle

The middle name of the patient

*only needed if CIE patient does not exist.

patient_gender

The gender of the patient

*only needed if CIE patient does not exist.

patient_mobile_phone

The mobile phone of the patient

*only needed if CIE patient does not exist.

patient_home_phone

The home phone number of the patient

*only needed if CIE patient does not exist.

patient_email

The email of the patient

*only needed if CIE patient does not exist.

patient_sms

The mobile phone number for texting with the patient

*only needed if CIE patient does not exist.

patient_address_0_line_0

The address of the patient and the first line of the address. This is an array which has been flattened. So if there are more then one then it will have a address_1 and so on.

*only needed if CIE patient does not exist.

patient_address_0_line_1

The address of the patient and the second line of the address. This is an array which has been flattened. So if there are more then one then it will have a address_1 and so on.

*only needed if CIE patient does not exist.

patient_address_0_city

The city of the patient. This is an array which has been flattened. So if there are more then one then it will have a address_1 and so on.

*only needed if CIE patient does not exist.

patient_address_0_state

The state of the patient. This is an array which has been flattened. So if there are more then one then it will have a address_1 and so on.

*only needed if CIE patient does not exist.

patient_address_0_postalcode

The postal code of the patient. This is an array which has been flatten. So if there are more then one then it will have a address_1 and so on.

*only needed if CIE patient does not exist.

patient_birthDate

The birth date of the patient

*only needed if CIE patient does not exist.

Example File

  • No labels