@healthcloudai/hc-sdk 3.17.0 → 3.18.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +3 -0
- package/dist/index.d.cts +21 -0
- package/dist/index.d.ts +21 -0
- package/dist/index.js +3 -0
- package/docs/docs-manifest.json +71 -11
- package/docs/models/AlcoholFrequency.md +15 -0
- package/docs/models/AlcoholUse.md +20 -0
- package/docs/models/BodyHeight.md +17 -0
- package/docs/models/BodyTemperature.md +18 -0
- package/docs/models/BodyWeight.md +18 -0
- package/docs/models/BookAppointmentRequest.md +2 -0
- package/docs/models/DietCategory.md +19 -0
- package/docs/models/EducationLevel.md +15 -0
- package/docs/models/ExerciseFrequency.md +15 -0
- package/docs/models/FunctionalLevel.md +15 -0
- package/docs/models/FunctionalStatus.md +40 -0
- package/docs/models/GetPractitionerResponse.md +8 -2
- package/docs/models/LicenseVerification.md +19 -0
- package/docs/models/ListAllergiesResponse.md +1 -1
- package/docs/models/ListConditionsResponse.md +1 -1
- package/docs/models/ListDirectivesResponse.md +1 -1
- package/docs/models/ListFamilyHistoryResponse.md +1 -1
- package/docs/models/ListImmunizationsResponse.md +1 -1
- package/docs/models/ListProceduresResponse.md +1 -1
- package/docs/models/ListQuestionnaireResponsesResponse.md +1 -1
- package/docs/models/LivingSituation.md +15 -0
- package/docs/models/NpiVerification.md +21 -0
- package/docs/models/OnboardingProgressRequest.md +18 -0
- package/docs/models/PortalRole.md +18 -0
- package/docs/models/Practitioner.md +9 -2
- package/docs/models/ProviderCredential.md +19 -0
- package/docs/models/ProviderEducationCredential.md +6 -2
- package/docs/models/ProviderEncounterListResponse.md +1 -1
- package/docs/models/ProviderEncounterRecord.md +49 -0
- package/docs/models/ProviderEncounterResponse.md +1 -1
- package/docs/models/ProviderLanguage.md +3 -2
- package/docs/models/ProviderOnboardingStatus.md +19 -0
- package/docs/models/ProviderPatientRecordResources.md +32 -0
- package/docs/models/ProviderPatientRecordResponse.md +1 -1
- package/docs/models/ProviderPostgraduateTraining.md +22 -0
- package/docs/models/ProviderProfessionalLiability.md +19 -0
- package/docs/models/ProviderSpecialty.md +1 -1
- package/docs/models/ProviderStateLicense.md +9 -2
- package/docs/models/SexualOrientation.md +15 -0
- package/docs/models/SmokingStatus.md +15 -0
- package/docs/models/SocialHistory.md +35 -0
- package/docs/models/SubstanceStatus.md +15 -0
- package/docs/models/SubstanceUse.md +23 -0
- package/docs/models/TobaccoUse.md +22 -0
- package/docs/models/UpdateEncounterClinicalNoteResponse.md +1 -1
- package/docs/models/UpdateEncounterStatusResponse.md +1 -1
- package/docs/models/UpdatePractitionerRequest.md +5 -0
- package/docs/models/UpdatePractitionerResponse.md +8 -2
- package/docs/models/VitalsRecord.md +41 -0
- package/docs/models/appointments.ErrorResponse.md +1 -0
- package/docs/models/diagnostics.Coding.md +19 -0
- package/docs/models/diagnostics.LabObservation.md +1 -1
- package/docs/models/{AdvanceDirective.md → ehr.AdvanceDirective.md} +1 -1
- package/docs/models/{Allergy.md → ehr.Allergy.md} +1 -1
- package/docs/models/ehr.Coding.md +19 -0
- package/docs/models/{FamilyHistoryEntry.md → ehr.FamilyHistoryEntry.md} +1 -1
- package/docs/models/{Immunization.md → ehr.Immunization.md} +1 -1
- package/docs/models/{Problem.md → ehr.Problem.md} +1 -1
- package/docs/models/{Procedure.md → ehr.Procedure.md} +1 -1
- package/docs/models/ehr.Quantity.md +20 -0
- package/docs/models/{QuestionnaireResponse.md → ehr.QuestionnaireResponse.md} +2 -2
- package/docs/models/{ResponseAnswer.md → ehr.ResponseAnswer.md} +4 -4
- package/docs/models/{ResponseItem.md → ehr.ResponseItem.md} +3 -3
- package/docs/models/index.md +69 -9
- package/docs/models/provider.AdvanceDirective.md +31 -0
- package/docs/models/provider.Allergy.md +31 -0
- package/docs/models/provider.AllergyReaction.md +21 -0
- package/docs/models/provider.BloodPressure.md +20 -0
- package/docs/models/provider.CodedConcept.md +19 -0
- package/docs/models/provider.Coding.md +19 -0
- package/docs/models/provider.Dosage.md +24 -0
- package/docs/models/provider.Encounter.md +48 -0
- package/docs/models/provider.EncounterDiagnosis.md +20 -0
- package/docs/models/provider.EncounterHospitalization.md +22 -0
- package/docs/models/provider.EncounterLocation.md +21 -0
- package/docs/models/provider.EncounterParticipant.md +21 -0
- package/docs/models/provider.FamilyCondition.md +22 -0
- package/docs/models/provider.FamilyHistoryEntry.md +30 -0
- package/docs/models/provider.GynHistory.md +25 -0
- package/docs/models/provider.HeartRate.md +18 -0
- package/docs/models/provider.Immunization.md +40 -0
- package/docs/models/provider.ImmunizationReaction.md +20 -0
- package/docs/models/provider.LabObservation.md +29 -0
- package/docs/models/provider.Medication.md +41 -0
- package/docs/models/provider.PerinatalHistory.md +25 -0
- package/docs/models/provider.Problem.md +37 -0
- package/docs/models/provider.Procedure.md +37 -0
- package/docs/models/provider.PulseOximetry.md +20 -0
- package/docs/models/provider.Quantity.md +20 -0
- package/docs/models/provider.QuestionnaireResponse.md +27 -0
- package/docs/models/provider.ReferenceRange.md +20 -0
- package/docs/models/provider.ResponseAnswer.md +27 -0
- package/docs/models/provider.ResponseItem.md +21 -0
- package/docs/operations/appointments.book.md +34 -1
- package/docs/operations/provider.getEncounter.md +84 -1
- package/docs/operations/provider.getPatientRecord.md +516 -1
- package/docs/operations/provider.getPractitioner.md +92 -53
- package/docs/operations/provider.listEncounters.md +84 -1
- package/docs/operations/provider.register.md +25 -3
- package/docs/operations/provider.updateEncounterClinicalNote.md +84 -1
- package/docs/operations/provider.updateEncounterStatus.md +84 -1
- package/docs/operations/provider.updatePractitioner.md +256 -150
- package/package.json +1 -1
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# BloodPressure
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.BloodPressure`
|
|
4
|
+
|
|
5
|
+
A blood pressure reading.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `arm` | `string|null` | No | | | | Yes | Left, Right, Either |
|
|
14
|
+
| `diastolic` | `number` | Yes | | | | No | mmHg |
|
|
15
|
+
| `position` | [`PositionCode`](./PositionCode.md) | No | | | | Yes | Patient position during the reading, optional. |
|
|
16
|
+
| `systolic` | `number` | Yes | | | | No | mmHg |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# CodedConcept
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.CodedConcept`
|
|
4
|
+
|
|
5
|
+
A clinical concept identified by one or more coding systems.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `code` | `string` | Yes | | | | No | Code value from the coding system (e.g. an ICD-10 or SNOMED CT code). |
|
|
14
|
+
| `display` | `string` | Yes | | | | No | Human-readable display text for the code. |
|
|
15
|
+
| `system` | `string|null` | No | | | | Yes | e.g. ICD-10, SNOMED-CT, CPT, CVX, RxNorm, NDC |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Coding
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.Coding`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `code` | `string|null` | No | | | | Yes | Code within the system. |
|
|
14
|
+
| `display` | `string|null` | No | | | | Yes | Human-readable label. |
|
|
15
|
+
| `system` | `string|null` | No | | | | Yes | Code system URI. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Dosage
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.Dosage`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `duration_days` | `integer|null` | No | | | | Yes | Number of days the medication should be taken, for a finite course. |
|
|
14
|
+
| `frequency` | [`MedicationFrequency`](./MedicationFrequency.md) | Yes | | | | No | How often the dose is taken (e.g. once_daily, twice_daily, as_needed). |
|
|
15
|
+
| `frequency_details` | `string|null` | No | | | | Yes | Free-text frequency details when frequency is 'other' or needs clarification. |
|
|
16
|
+
| `instructions` | `string|null` | No | | | | Yes | Free-text patient instructions for taking the dose, when present. |
|
|
17
|
+
| `max_daily_dose` | `number|null` | No | | | | Yes | Maximum dose allowed per day, when specified. |
|
|
18
|
+
| `max_daily_dose_unit` | `string|null` | No | | | | Yes | Unit for max_daily_dose (e.g. mg, mcg), when specified. |
|
|
19
|
+
| `unit` | `string` | Yes | | | | No | mg, mcg, mL, units, puffs, drops, etc. |
|
|
20
|
+
| `value` | `number` | Yes | | | | No | Dose amount per administration. |
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# Encounter
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.Encounter`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `appointment_id` | `string|null` | No | | | | Yes | FHIR Appointment id this encounter fulfills, when linked. |
|
|
14
|
+
| `athena_appointment_id` | `string|null` | No | | | | Yes | Athena Health appointment id this encounter was checked in from, when checked in via Athena. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
|
|
15
|
+
| `athena_encounter_id` | `string|null` | No | | | | Yes | Athena Health encounter id this encounter is linked to, when checked in via Athena. |
|
|
16
|
+
| `created_by` | `string` | No | | | `"self"` | No | Person FHIR resource ID of the creating field agent, or 'self' |
|
|
17
|
+
| `created_date` | `string|null` | No | | | | Yes | UTC datetime when the encounter was created |
|
|
18
|
+
| `diagnoses` | array of [`provider.EncounterDiagnosis`](./provider.EncounterDiagnosis.md) | No | | | | No | Diagnoses recorded for this encounter, ranked by rank. |
|
|
19
|
+
| `encounter_class` | [`EncounterClass`](./EncounterClass.md) | No | | | `"AMB"` | No | Encounter class: AMB (ambulatory), EMER (emergency), FLD (field), HH (home health), ACUTE, NONAC, OBSENC, PRENC, SS, or VR (virtual). |
|
|
20
|
+
| `encounter_id` | `string` | No | uuid | | | No | HealthCloud encounter identifier (UUID). |
|
|
21
|
+
| `fhir_id` | `string|null` | No | | | | Yes | FHIR Encounter resource id, when stored. |
|
|
22
|
+
| `hospitalization` | [`provider.EncounterHospitalization`](./provider.EncounterHospitalization.md) | No | | | | Yes | Hospitalization details (admit source, discharge disposition, etc.), for inpatient encounters. |
|
|
23
|
+
| `length_minutes` | `integer|null` | No | | | | Yes | Duration of the encounter in minutes, when known. |
|
|
24
|
+
| `locations` | array of [`provider.EncounterLocation`](./provider.EncounterLocation.md) | No | | | | No | Locations where the encounter takes place, with status and period. |
|
|
25
|
+
| `notes` | `string|null` | No | | | | Yes | Free-text encounter notes, e.g. synced from an external EHR's assessment/SOAP note. |
|
|
26
|
+
| `openloop_appointment_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) appointment id this encounter was checked in from, when checked in via OpenLoop. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
|
|
27
|
+
| `openloop_encounter_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) Patient Encounter id this encounter is linked to, when checked in via OpenLoop. |
|
|
28
|
+
| `participants` | array of [`provider.EncounterParticipant`](./provider.EncounterParticipant.md) | No | | | | No | Practitioners participating in the encounter, with their roles. |
|
|
29
|
+
| `patient_id` | `string` | Yes | | | | No | FHIR Patient id who is the subject of the encounter. |
|
|
30
|
+
| `period_end` | `string|null` | No | | | | Yes | When the encounter ended, when recorded. |
|
|
31
|
+
| `period_start` | `string|null` | No | | | | Yes | When the encounter started, when recorded. |
|
|
32
|
+
| `priority_code` | `string|null` | No | | | | Yes | Code for the encounter priority (e.g. routine, urgent, emergent), when coded. |
|
|
33
|
+
| `priority_display` | `string|null` | No | | | | Yes | Display text for the encounter priority, when available. |
|
|
34
|
+
| `reason_code` | `string|null` | No | | | | Yes | SNOMED CT code for the reason for the encounter, when coded. |
|
|
35
|
+
| `reason_display` | `string|null` | No | | | | Yes | Display text for the reason for the encounter, when available. |
|
|
36
|
+
| `service_provider_display` | `string|null` | No | | | | Yes | Display name of the service provider organization, when available. |
|
|
37
|
+
| `service_provider_id` | `string|null` | No | | | | Yes | FHIR Organization id of the service provider, when linked. |
|
|
38
|
+
| `service_type_code` | `string|null` | No | | | | Yes | SNOMED CT code for the service type, when coded. |
|
|
39
|
+
| `service_type_display` | `string|null` | No | | | | Yes | Display text for the service type, when available. |
|
|
40
|
+
| `status` | [`EncounterStatus`](./EncounterStatus.md) | No | | | `"planned"` | No | Encounter status: planned, arrived, triaged, in-progress, onleave, finished, cancelled, entered-in-error, or unknown. |
|
|
41
|
+
| `steadymd_consult_guid` | `string|null` | No | | | | Yes | SteadyMD consult guid this encounter was checked in from, when checked in via SteadyMD. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
|
|
42
|
+
| `steadymd_episode_guid` | `string|null` | No | | | | Yes | SteadyMD episode guid this encounter is linked to, when checked in via SteadyMD. |
|
|
43
|
+
| `type_code` | `string|null` | No | | | | Yes | SNOMED CT code for the encounter type (e.g. office visit, follow-up), when coded. |
|
|
44
|
+
| `type_display` | `string|null` | No | | | | Yes | Display text for the encounter type, when available. |
|
|
45
|
+
|
|
46
|
+
## Example
|
|
47
|
+
|
|
48
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# EncounterDiagnosis
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.EncounterDiagnosis`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `condition_display` | `string|null` | No | | | | Yes | Display text for the diagnosis, when available. |
|
|
14
|
+
| `condition_id` | `string` | Yes | | | | No | FHIR Condition id referenced by this diagnosis. |
|
|
15
|
+
| `rank` | `integer` | No | | | `1` | No | Ranking of this diagnosis relative to others in the encounter (1 = primary). |
|
|
16
|
+
| `use_code` | `string` | No | | | `"CC"` | No | Diagnosis use code (e.g. CC chief complaint, AD admission diagnosis). |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# EncounterHospitalization
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.EncounterHospitalization`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `admit_source_code` | `string|null` | No | | | | Yes | Code for the patient's admission source (e.g. emergency, referral), when recorded. |
|
|
14
|
+
| `destination_id` | `string|null` | No | | | | Yes | FHIR Location id the patient was discharged to, when applicable. |
|
|
15
|
+
| `discharge_disposition` | [`DischargeDisposition`](./DischargeDisposition.md) | No | | | | Yes | Discharge disposition (e.g. home, skilled nursing, expired), when recorded. |
|
|
16
|
+
| `origin_id` | `string|null` | No | | | | Yes | FHIR Location id the patient came from before admission, when applicable. |
|
|
17
|
+
| `pre_admission_id` | `string|null` | No | | | | Yes | Identifier of any pre-admission encounter, when applicable. |
|
|
18
|
+
| `re_admission_code` | `string|null` | No | | | | Yes | Code indicating this is a readmission, when applicable. |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# EncounterLocation
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.EncounterLocation`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `location_display` | `string|null` | No | | | | Yes | Display name of the location, when available. |
|
|
14
|
+
| `location_id` | `string` | Yes | | | | No | FHIR Location id where the encounter takes place. |
|
|
15
|
+
| `period_end` | `string|null` | No | | | | Yes | When the patient was at this location, end, when recorded. |
|
|
16
|
+
| `period_start` | `string|null` | No | | | | Yes | When the patient was at this location, start, when recorded. |
|
|
17
|
+
| `status` | [`LocationStatus`](./LocationStatus.md) | No | | | `"active"` | No | Location status during the encounter: planned, active, reserved, or completed. |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# EncounterParticipant
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.EncounterParticipant`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `participant_type` | [`ParticipantType`](./ParticipantType.md) | No | | | `"PPRF"` | No | Role of the participant in the encounter (e.g. PPRF primary performer, ATND attender, ADM admitter). |
|
|
14
|
+
| `period_end` | `string|null` | No | | | | Yes | When the participant's involvement ended, when recorded. |
|
|
15
|
+
| `period_start` | `string|null` | No | | | | Yes | When the participant's involvement started, when recorded. |
|
|
16
|
+
| `practitioner_display` | `string|null` | No | | | | Yes | Display name of the practitioner, when known. |
|
|
17
|
+
| `practitioner_id` | `string` | Yes | | | | No | FHIR Practitioner id of the participant. |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# FamilyCondition
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.FamilyCondition`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `age_at_death` | `integer|null` | No | | | | Yes | Age of the family member at death, when known. |
|
|
14
|
+
| `age_at_onset` | `integer|null` | No | | | | Yes | Age of the family member at onset of the condition, when known. |
|
|
15
|
+
| `condition` | `string` | Yes | | | | No | Name/description of the family member's condition. |
|
|
16
|
+
| `icd10_code` | `string|null` | No | | | | Yes | ICD-10-CM code for the condition, when coded. |
|
|
17
|
+
| `notes` | `string|null` | No | | | | Yes | Free-text notes about the condition, when present. |
|
|
18
|
+
| `snomed_code` | `string|null` | No | | | | Yes | SNOMED CT code for the family member's condition, when known. |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# FamilyHistoryEntry
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.FamilyHistoryEntry`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `age_at_death` | `integer|null` | No | | | | Yes | Age of the family member at death, when known. |
|
|
14
|
+
| `biological` | `boolean` | No | | | `true` | No | Whether the family member is a biological relative. |
|
|
15
|
+
| `born_date` | `string|null` | No | | | | Yes | Birth date of the family member, when known. |
|
|
16
|
+
| `cause_of_death` | `string|null` | No | | | | Yes | Cause of death of the family member, when recorded. |
|
|
17
|
+
| `conditions` | array of [`provider.FamilyCondition`](./provider.FamilyCondition.md) | No | | | | No | Conditions recorded for this family member. |
|
|
18
|
+
| `deceased` | `boolean|null` | No | | | | Yes | Whether the family member is deceased, when known. |
|
|
19
|
+
| `entry_id` | `string` | No | uuid | | | No | HealthCloud family-history entry identifier (UUID). |
|
|
20
|
+
| `fhir_id` | `string|null` | No | | | | Yes | FHIR FamilyMemberHistory resource id, when stored. |
|
|
21
|
+
| `member_name` | `string|null` | No | | | | Yes | Name of the family member, when known (FHIR FamilyMemberHistory.name). |
|
|
22
|
+
| `notes` | `string|null` | No | | | | Yes | Free-text notes about the family member, when present. |
|
|
23
|
+
| `recorded_date` | `string|null` | No | | | | Yes | Date the family-history entry was recorded, when known. |
|
|
24
|
+
| `relationship` | [`FamilyRelationship`](./FamilyRelationship.md) | Yes | | | | No | Relationship of the family member to the patient (e.g. mother, father, sibling). |
|
|
25
|
+
| `sex` | `string|null` | No | | | | Yes | Sex of the family member, when known. |
|
|
26
|
+
| `status` | [`FamilyHistoryStatus`](./FamilyHistoryStatus.md) | No | | | `"completed"` | No | Status of the family-history entry (required in FHIR): partial, completed, entered-in-error, or health-unknown. |
|
|
27
|
+
|
|
28
|
+
## Example
|
|
29
|
+
|
|
30
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# GynHistory
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.GynHistory`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `cervical_screening_history` | `string|null` | No | | | | Yes | |
|
|
14
|
+
| `contraception` | `string|null` | No | | | | Yes | |
|
|
15
|
+
| `history_id` | `string` | No | uuid | | | No | |
|
|
16
|
+
| `last_menstrual_period` | `string|null` | No | | | | Yes | |
|
|
17
|
+
| `menarche_age` | `integer|null` | No | | | | Yes | |
|
|
18
|
+
| `menopause_age` | `integer|null` | No | | | | Yes | |
|
|
19
|
+
| `menstrual_history` | `string|null` | No | | | | Yes | |
|
|
20
|
+
| `notes` | `string|null` | No | | | | Yes | |
|
|
21
|
+
| `pregnancy_history` | `string|null` | No | | | | Yes | |
|
|
22
|
+
|
|
23
|
+
## Example
|
|
24
|
+
|
|
25
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# HeartRate
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.HeartRate`
|
|
4
|
+
|
|
5
|
+
A heart rate reading.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `rate` | `number` | Yes | | | | No | beats/min |
|
|
14
|
+
| `rhythm` | `string|null` | No | | | | Yes | Regular, Irregular, etc. |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Immunization
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.Immunization`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `administered_by` | `string|null` | No | | | | Yes | |
|
|
14
|
+
| `administered_date` | `string|null` | No | | | | Yes | |
|
|
15
|
+
| `administered_datetime` | `string|null` | No | | | | Yes | |
|
|
16
|
+
| `cvx_code` | `string|null` | No | | | | Yes | |
|
|
17
|
+
| `dose_number` | `integer|null` | No | | | | Yes | |
|
|
18
|
+
| `dose_quantity` | `number|null` | No | | | | Yes | |
|
|
19
|
+
| `dose_unit` | `string|null` | No | | | | Yes | |
|
|
20
|
+
| `expiration_date` | `string|null` | No | | | | Yes | |
|
|
21
|
+
| `fhir_id` | `string|null` | No | | | | Yes | |
|
|
22
|
+
| `immunization_id` | `string` | No | uuid | | | No | |
|
|
23
|
+
| `lot_number` | `string|null` | No | | | | Yes | |
|
|
24
|
+
| `manufacturer` | `string|null` | No | | | | Yes | |
|
|
25
|
+
| `mvx_code` | `string|null` | No | | | | Yes | |
|
|
26
|
+
| `not_done_reason` | `string|null` | No | | | | Yes | |
|
|
27
|
+
| `notes` | `string|null` | No | | | | Yes | |
|
|
28
|
+
| `reactions` | array of [`provider.ImmunizationReaction`](./provider.ImmunizationReaction.md) | No | | | | No | |
|
|
29
|
+
| `reason_codes` | `array` | No | | | | No | |
|
|
30
|
+
| `route` | [`ImmunizationRoute`](./ImmunizationRoute.md) | No | | | | Yes | |
|
|
31
|
+
| `series_doses` | `integer|null` | No | | | | Yes | |
|
|
32
|
+
| `series_name` | `string|null` | No | | | | Yes | |
|
|
33
|
+
| `site` | [`VaccinationSite`](./VaccinationSite.md) | No | | | | Yes | |
|
|
34
|
+
| `status` | [`ImmunizationStatus`](./ImmunizationStatus.md) | No | | | `"completed"` | No | |
|
|
35
|
+
| `vaccine_name` | `string` | Yes | | | | No | |
|
|
36
|
+
| `vis_document_date` | `string|null` | No | | | | Yes | |
|
|
37
|
+
|
|
38
|
+
## Example
|
|
39
|
+
|
|
40
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# ImmunizationReaction
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.ImmunizationReaction`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `notes` | `string|null` | No | | | | Yes | |
|
|
14
|
+
| `onset_date` | `string|null` | No | | | | Yes | |
|
|
15
|
+
| `reaction` | `string` | Yes | | | | No | |
|
|
16
|
+
| `severity` | [`ReactionSeverity`](./ReactionSeverity.md) | No | | | | Yes | |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# LabObservation
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.LabObservation`
|
|
4
|
+
|
|
5
|
+
A single lab result line item, mapped to/from a FHIR Observation.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `display` | `string` | Yes | | | | No | Human-readable name of the measured analyte. |
|
|
14
|
+
| `effective_datetime` | `string|null` | No | | | | Yes | ISO 8601 datetime the observation was effective, optional. |
|
|
15
|
+
| `interpretation` | [`InterpretationCode`](./InterpretationCode.md) | No | | | | Yes | Clinical interpretation flag, e.g. high/low/critical/positive/negative. |
|
|
16
|
+
| `loinc_code` | `string` | Yes | | | | No | LOINC code identifying the measured analyte. |
|
|
17
|
+
| `notes` | `string|null` | No | | | | Yes | Free-text notes, optional. |
|
|
18
|
+
| `observation_id` | `string|null` | No | | | | Yes | FHIR Observation resource ID; auto-generated if omitted. |
|
|
19
|
+
| `reference_range` | [`provider.ReferenceRange`](./provider.ReferenceRange.md) | No | | | | Yes | The normal/expected range for this result, optional. |
|
|
20
|
+
| `status` | [`ObservationStatus`](./ObservationStatus.md) | No | | | `"final"` | No | Observation lifecycle status. |
|
|
21
|
+
| `value_boolean` | `boolean|null` | No | | | | Yes | Boolean result value, when applicable. |
|
|
22
|
+
| `value_coding` | [`provider.Coding`](./provider.Coding.md) | No | | | | Yes | Coded result value, when applicable. |
|
|
23
|
+
| `value_quantity` | `number|null` | No | | | | Yes | Numeric result value, when the result is quantitative. Requires value_unit. |
|
|
24
|
+
| `value_string` | `string|null` | No | | | | Yes | Free-text result value, when the result is not quantitative. |
|
|
25
|
+
| `value_unit` | `string|null` | No | | | | Yes | Unit of measure for value_quantity, optional. |
|
|
26
|
+
|
|
27
|
+
## Example
|
|
28
|
+
|
|
29
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Medication
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.Medication`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `authored_on` | `string|null` | No | | | | Yes | Date the prescription was authored, when recorded. |
|
|
14
|
+
| `brand_name` | `string|null` | No | | | | Yes | Brand name of the medication, when known. |
|
|
15
|
+
| `discontinued_reason` | `string|null` | No | | | | Yes | Reason the medication was discontinued, when applicable. |
|
|
16
|
+
| `dosage` | [`provider.Dosage`](./provider.Dosage.md) | Yes | | | | No | Dose, frequency, and instructions for the medication. |
|
|
17
|
+
| `encounter_id` | `string|null` | No | | | | Yes | FHIR Encounter id during which the medication was ordered, when linked. |
|
|
18
|
+
| `end_date` | `string|null` | No | | | | Yes | Date the medication therapy ends, when specified. |
|
|
19
|
+
| `fhir_id` | `string|null` | No | | | | Yes | FHIR MedicationRequest/MedicationStatement resource id, when stored. |
|
|
20
|
+
| `generic_name` | `string|null` | No | | | | Yes | Generic name of the medication, when known. |
|
|
21
|
+
| `indication` | `string|null` | No | | | | Yes | Reason/indication for the medication, when recorded. |
|
|
22
|
+
| `intent` | [`MedicationIntent`](./MedicationIntent.md) | No | | | `"order"` | No | Request intent: proposal, plan, order, or original-order (required for MedicationRequest). |
|
|
23
|
+
| `medication_id` | `string` | No | uuid | | | No | HealthCloud medication identifier (UUID). |
|
|
24
|
+
| `name` | `string` | Yes | | | | No | Generic or brand name |
|
|
25
|
+
| `ndc_code` | `string|null` | No | | | | Yes | National Drug Code (NDC) for the medication, when available. |
|
|
26
|
+
| `notes` | `string|null` | No | | | | Yes | Free-text notes about the medication, when present. |
|
|
27
|
+
| `pharmacy` | `string|null` | No | | | | Yes | Dispensing pharmacy name or reference, when recorded. |
|
|
28
|
+
| `prescriber_id` | `string|null` | No | | | | Yes | FHIR Practitioner id of the prescriber, when known. |
|
|
29
|
+
| `prescriber_name` | `string|null` | No | | | | Yes | Display name of the prescriber, when known. |
|
|
30
|
+
| `problem_reference` | `string|null` | No | | | | Yes | UUID of the Condition (problem) this medication treats, when linked. |
|
|
31
|
+
| `refills_authorized` | `integer|null` | No | | | | Yes | Number of refills authorized on the prescription, when applicable. |
|
|
32
|
+
| `refills_remaining` | `integer|null` | No | | | | Yes | Number of refills remaining, when tracked. |
|
|
33
|
+
| `resource_type` | [`MedicationResourceType`](./MedicationResourceType.md) | No | | | `"MedicationRequest"` | No | Which FHIR resource this maps to: MedicationStatement (historical use) or MedicationRequest (prescription/order). |
|
|
34
|
+
| `route` | [`MedicationRoute`](./MedicationRoute.md) | Yes | | | | No | Administration route: oral, intravenous, intramuscular, topical, etc. |
|
|
35
|
+
| `rxnorm_code` | `string|null` | No | | | | Yes | RxNorm code for the medication, when available. |
|
|
36
|
+
| `start_date` | `string|null` | No | | | | Yes | Date the medication therapy starts, when specified. |
|
|
37
|
+
| `status` | [`MedicationStatus`](./MedicationStatus.md) | No | | | `"active"` | No | Medication status: active, on-hold, completed, stopped, or entered-in-error. |
|
|
38
|
+
|
|
39
|
+
## Example
|
|
40
|
+
|
|
41
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# PerinatalHistory
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.PerinatalHistory`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `delivery_date` | `string|null` | No | | | | Yes | |
|
|
14
|
+
| `delivery_method` | `string|null` | No | | | | Yes | |
|
|
15
|
+
| `gestational_age_weeks` | `number|null` | No | | | | Yes | |
|
|
16
|
+
| `history_id` | `string` | No | uuid | | | No | |
|
|
17
|
+
| `maternal_complications` | `string|null` | No | | | | Yes | |
|
|
18
|
+
| `neonatal_complications` | `string|null` | No | | | | Yes | |
|
|
19
|
+
| `notes` | `string|null` | No | | | | Yes | |
|
|
20
|
+
| `outcome` | `string|null` | No | | | | Yes | |
|
|
21
|
+
| `pregnancy_year` | `integer|null` | No | | | | Yes | |
|
|
22
|
+
|
|
23
|
+
## Example
|
|
24
|
+
|
|
25
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Problem
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.Problem`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `asserted_date` | `string|null` | No | | | | Yes | Date the problem was asserted, when recorded. |
|
|
14
|
+
| `asserter_name` | `string|null` | No | | | | Yes | Name of the person who asserted the problem, when recorded. |
|
|
15
|
+
| `asserter_type` | `string|null` | No | | | | Yes | Type of asserter (e.g. patient, practitioner), when recorded. |
|
|
16
|
+
| `body_site` | `string|null` | No | | | | Yes | Body site affected, when specified. |
|
|
17
|
+
| `categories` | array of [`ProblemCategory`](./ProblemCategory.md) | No | | | | No | Condition categories (e.g. problem-list-item, encounter-diagnosis). |
|
|
18
|
+
| `clinical_status` | [`ProblemClinicalStatus`](./ProblemClinicalStatus.md) | No | | | `"active"` | No | Clinical status: active, recurrence, relapse, inactive, remission, or resolved. |
|
|
19
|
+
| `description` | `string` | Yes | | | | No | Human-readable description of the problem/condition. |
|
|
20
|
+
| `encounter_id` | `string|null` | No | | | | Yes | FHIR Encounter id during which the problem was recorded, when linked. |
|
|
21
|
+
| `fhir_id` | `string|null` | No | | | | Yes | FHIR Condition resource id, when stored. |
|
|
22
|
+
| `icd10_code` | `string|null` | No | | | | Yes | ICD-10-CM code for the condition, when coded. |
|
|
23
|
+
| `laterality` | `string|null` | No | | | | Yes | Left, Right, Bilateral |
|
|
24
|
+
| `notes` | `string|null` | No | | | | Yes | Free-text notes about the problem, when present. |
|
|
25
|
+
| `onset_age` | `integer|null` | No | | | | Yes | Age at onset in years |
|
|
26
|
+
| `onset_date` | `string|null` | No | | | | Yes | Date the problem first onset, when known. |
|
|
27
|
+
| `problem_id` | `string` | No | uuid | | | No | HealthCloud problem/condition identifier (UUID). |
|
|
28
|
+
| `recorded_date` | `string|null` | No | | | | Yes | Datetime the problem was recorded, when known. |
|
|
29
|
+
| `recorder_name` | `string|null` | No | | | | Yes | Name of the person who recorded the problem, when known. |
|
|
30
|
+
| `resolved_date` | `string|null` | No | | | | Yes | Date the problem was resolved/abated, when applicable. |
|
|
31
|
+
| `severity` | [`ProblemSeverity`](./ProblemSeverity.md) | No | | | | Yes | Severity: mild, moderate, or severe, when assessed. |
|
|
32
|
+
| `snomed_code` | `string|null` | No | | | | Yes | SNOMED CT code for the condition, when coded. |
|
|
33
|
+
| `verification_status` | [`ProblemVerificationStatus`](./ProblemVerificationStatus.md) | No | | | `"confirmed"` | No | Verification status: unconfirmed, provisional, differential, confirmed, refuted, or entered-in-error. |
|
|
34
|
+
|
|
35
|
+
## Example
|
|
36
|
+
|
|
37
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Procedure
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.Procedure`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `anesthesia_type` | `string|null` | No | | | | Yes | |
|
|
14
|
+
| `body_sites` | `array` | No | | | | No | |
|
|
15
|
+
| `complications` | `array` | No | | | | No | |
|
|
16
|
+
| `cpt_code` | `string|null` | No | | | | Yes | |
|
|
17
|
+
| `description` | `string` | Yes | | | | No | |
|
|
18
|
+
| `encounter_id` | `string|null` | No | | | | Yes | |
|
|
19
|
+
| `facility` | `string|null` | No | | | | Yes | |
|
|
20
|
+
| `fhir_id` | `string|null` | No | | | | Yes | |
|
|
21
|
+
| `indication` | `string|null` | No | | | | Yes | |
|
|
22
|
+
| `laterality` | [`ProcedureLaterality`](./ProcedureLaterality.md) | No | | | | Yes | |
|
|
23
|
+
| `notes` | `string|null` | No | | | | Yes | |
|
|
24
|
+
| `outcome` | `string|null` | No | | | | Yes | |
|
|
25
|
+
| `performed_date` | `string|null` | No | | | | Yes | |
|
|
26
|
+
| `performed_date_end` | `string|null` | No | | | | Yes | |
|
|
27
|
+
| `performer_id` | `string|null` | No | | | | Yes | |
|
|
28
|
+
| `performer_name` | `string|null` | No | | | | Yes | |
|
|
29
|
+
| `problem_reference` | `string|null` | No | | | | Yes | |
|
|
30
|
+
| `procedure_id` | `string` | No | uuid | | | No | |
|
|
31
|
+
| `reported` | `boolean` | No | | | `false` | No | |
|
|
32
|
+
| `snomed_code` | `string|null` | No | | | | Yes | |
|
|
33
|
+
| `status` | [`ProcedureStatus`](./ProcedureStatus.md) | No | | | `"completed"` | No | |
|
|
34
|
+
|
|
35
|
+
## Example
|
|
36
|
+
|
|
37
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PulseOximetry
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.PulseOximetry`
|
|
4
|
+
|
|
5
|
+
An SpO2 (blood oxygen saturation) reading.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `fio2` | `number|null` | No | | | | Yes | FiO2 % |
|
|
14
|
+
| `flow_rate` | `number|null` | No | | | | Yes | O2 flow rate L/min |
|
|
15
|
+
| `on_supplemental_oxygen` | `boolean` | No | | | `false` | No | True if the patient was on supplemental oxygen during the reading. |
|
|
16
|
+
| `spo2` | `number` | Yes | | | | No | SpO2 percentage |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Quantity
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.Quantity`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `code` | `string|null` | No | | | | Yes | Unit code within the system. |
|
|
14
|
+
| `system` | `string|null` | No | | | | Yes | Unit code system URI. |
|
|
15
|
+
| `unit` | `string|null` | No | | | | Yes | Unit of measure, for display. |
|
|
16
|
+
| `value` | `number|null` | No | | | | Yes | Numeric value. |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# QuestionnaireResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `provider.QuestionnaireResponse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `authored` | `string|null` | No | | | | Yes | ISO 8601 dateTime |
|
|
14
|
+
| `authored_by_name` | `string|null` | No | | | | Yes | Display name of the author, when known. |
|
|
15
|
+
| `authored_by_patient` | `boolean` | No | | | `true` | No | Whether the response was authored by the patient (true) or a practitioner (false). |
|
|
16
|
+
| `encounter_id` | `string|null` | No | | | | Yes | FHIR Encounter id during which the response was collected, when linked. |
|
|
17
|
+
| `fhir_id` | `string|null` | No | | | | Yes | FHIR QuestionnaireResponse resource id, when stored. |
|
|
18
|
+
| `items` | array of [`provider.ResponseItem`](./provider.ResponseItem.md) | No | | | | No | Response items (answers), one per Questionnaire item linkId. |
|
|
19
|
+
| `patient_fhir_id` | `string|null` | No | | | | Yes | FHIR Patient id who is the subject of the response, when linked. |
|
|
20
|
+
| `questionnaire_fhir_id` | `string|null` | No | | | | Yes | FHIR Questionnaire id this response answers, when linked. |
|
|
21
|
+
| `questionnaire_url` | `string|null` | No | | | | Yes | Canonical URL of the Questionnaire |
|
|
22
|
+
| `response_id` | `string` | No | uuid | | | No | HealthCloud questionnaire-response identifier (UUID). |
|
|
23
|
+
| `status` | [`QuestionnaireResponseStatus`](./QuestionnaireResponseStatus.md) | No | | | `"completed"` | No | Response status: in-progress, completed, amended, entered-in-error, or stopped. |
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
None declared in canonical OpenAPI.
|