@healthcloudai/hc-sdk 2.13.0 → 2.15.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.
@@ -46,6 +46,7 @@
46
46
  - [`getAttributes`](../operations/patient.getPatientAttributes.md) — Get patient attributes
47
47
  - [`getDashboard`](../operations/patient.getPatientDashboard.md) — Get the patient dashboard summary
48
48
  - [`getFlags`](../operations/patient.getPatientFlags.md) — Get patient flags
49
+ - [`getPatientIntake`](../operations/patient.getPatientIntake.md) — Get own patient intake submission and delivery status
49
50
  - [`getPatientSidebar`](../operations/patient.getPatientSidebarPatientSidebar.md) — Get the patient sidebar summary
50
51
  - [`getPhoto`](../operations/patient.getPhoto.md) — Get a patient photo
51
52
  - [`getPreferredPharmacy`](../operations/patient.getPreferredPharmacy.md) — Get preferred pharmacy
@@ -65,6 +66,7 @@
65
66
  - [`searchKnowledge`](../operations/patient.searchKnowledge.md) — Search the knowledge base
66
67
  - [`setPreferredPharmacy`](../operations/patient.setPreferredPharmacy.md) — Set preferred pharmacy
67
68
  - [`createCurrentScreeningSymptoms`](../operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md) — Submit current symptoms
69
+ - [`submitPatientIntake`](../operations/patient.submitPatientIntake.md) — Submit patient-reported health record intake
68
70
  - [`updateAddress`](../operations/patient.updateAddress.md) — Update home address
69
71
  - [`updateDemographics`](../operations/patient.updateDemographics.md) — Update demographics
70
72
  - [`updateDriversLicense`](../operations/patient.updateDriversLicense.md) — Update the patient's driver's license
@@ -1,5 +1,5 @@
1
1
  {
2
- "docsDataContentDigest": "sha256:6d74c15aaed7ef44dea79f89e4d08dbafee7f1d4f1b556b166a5697b89d30a64",
2
+ "docsDataContentDigest": "sha256:f423f41d78e0d04b6320d54d784e1964fb841122e54322e5f052da10f836c388",
3
3
  "generatedFiles": [
4
4
  "authentication.md",
5
5
  "clients/AnthropicClient.md",
@@ -65,7 +65,6 @@
65
65
  "models/Allergy.md",
66
66
  "models/AllergyCategory.md",
67
67
  "models/AllergyCriticality.md",
68
- "models/AllergyReaction.md",
69
68
  "models/AllergyStatus.md",
70
69
  "models/AllergyVerificationStatus.md",
71
70
  "models/AnalyzeIdentityDocumentRequest.md",
@@ -440,7 +439,6 @@
440
439
  "models/CmsGetCountyFipsRequest.md",
441
440
  "models/CmsSearchHealthPlansRequest.md",
442
441
  "models/CmsSearchHealthPlansResponse.md",
443
- "models/CodedConcept.md",
444
442
  "models/CommGroupRecord.md",
445
443
  "models/CommsGetStateResponse.md",
446
444
  "models/CommsGetUnreadCountResponse.md",
@@ -555,7 +553,6 @@
555
553
  "models/Ethnicity.md",
556
554
  "models/FaceMatchRequest.md",
557
555
  "models/FaceMatchResponse.md",
558
- "models/FamilyCondition.md",
559
556
  "models/FamilyHistoryEntry.md",
560
557
  "models/FamilyHistoryStatus.md",
561
558
  "models/FamilyRelationship.md",
@@ -1325,6 +1322,8 @@
1325
1322
  "models/ParticipantType.md",
1326
1323
  "models/PatientAlertsResponse.md",
1327
1324
  "models/PatientDemographics.md",
1325
+ "models/PatientIntakeRequest.md",
1326
+ "models/PatientIntakeResponse.md",
1328
1327
  "models/PatientLink.md",
1329
1328
  "models/PatientLinkType.md",
1330
1329
  "models/PatientName.md",
@@ -1918,7 +1917,10 @@
1918
1917
  "models/diagnostics.LabObservation.md",
1919
1918
  "models/diagnostics.ListDiagnosticsResponse.md",
1920
1919
  "models/diagnostics.ReferenceRange.md",
1920
+ "models/ehr.AllergyReaction.md",
1921
+ "models/ehr.CodedConcept.md",
1921
1922
  "models/ehr.ConnectResponse.md",
1923
+ "models/ehr.FamilyCondition.md",
1922
1924
  "models/ehr.ListDiagnosticsResponse.md",
1923
1925
  "models/ehr.ListEncountersResponse.md",
1924
1926
  "models/ehr.ListMedicationsResponse.md",
@@ -2957,6 +2959,7 @@
2957
2959
  "operations/patient.getPatientAttributes.md",
2958
2960
  "operations/patient.getPatientDashboard.md",
2959
2961
  "operations/patient.getPatientFlags.md",
2962
+ "operations/patient.getPatientIntake.md",
2960
2963
  "operations/patient.getPatientSidebarPatientSidebar.md",
2961
2964
  "operations/patient.getPhoto.md",
2962
2965
  "operations/patient.getPreferredPharmacy.md",
@@ -2981,6 +2984,7 @@
2981
2984
  "operations/patient.searchKnowledge.md",
2982
2985
  "operations/patient.setPreferredPharmacy.md",
2983
2986
  "operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md",
2987
+ "operations/patient.submitPatientIntake.md",
2984
2988
  "operations/patient.updateAddress.md",
2985
2989
  "operations/patient.updateDemographics.md",
2986
2990
  "operations/patient.updateDriversLicense.md",
@@ -3032,7 +3036,7 @@
3032
3036
  "operations/vitals.recordVitals.md"
3033
3037
  ],
3034
3038
  "language": "nodejs",
3035
- "modelCount": 1974,
3036
- "operationCount": 1002,
3039
+ "modelCount": 1976,
3040
+ "operationCount": 1004,
3037
3041
  "schemaVersion": 1
3038
3042
  }
@@ -931,6 +931,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
931
931
  - [Get patient attributes](../operations/patient.getPatientAttributes.md)
932
932
  - [Get the patient dashboard summary](../operations/patient.getPatientDashboard.md)
933
933
  - [Get patient flags](../operations/patient.getPatientFlags.md)
934
+ - [Get own patient intake submission and delivery status](../operations/patient.getPatientIntake.md)
934
935
  - [Get the patient sidebar summary](../operations/patient.getPatientSidebarPatientSidebar.md)
935
936
  - [Get a patient photo](../operations/patient.getPhoto.md)
936
937
  - [Get preferred pharmacy](../operations/patient.getPreferredPharmacy.md)
@@ -955,6 +956,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
955
956
  - [Search the knowledge base](../operations/patient.searchKnowledge.md)
956
957
  - [Set preferred pharmacy](../operations/patient.setPreferredPharmacy.md)
957
958
  - [Submit current symptoms](../operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md)
959
+ - [Submit patient-reported health record intake](../operations/patient.submitPatientIntake.md)
958
960
  - [Update home address](../operations/patient.updateAddress.md)
959
961
  - [Update demographics](../operations/patient.updateDemographics.md)
960
962
  - [Update the patient's driver's license](../operations/patient.updateDriversLicense.md)
package/docs/index.md CHANGED
@@ -939,6 +939,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
939
939
  - [Get patient attributes](operations/patient.getPatientAttributes.md) (`patient.getPatientAttributes`)
940
940
  - [Get the patient dashboard summary](operations/patient.getPatientDashboard.md) (`patient.getPatientDashboard`)
941
941
  - [Get patient flags](operations/patient.getPatientFlags.md) (`patient.getPatientFlags`)
942
+ - [Get own patient intake submission and delivery status](operations/patient.getPatientIntake.md) (`patient.getPatientIntake`)
942
943
  - [Get the patient sidebar summary](operations/patient.getPatientSidebarPatientSidebar.md) (`patient.getPatientSidebarPatientSidebar`)
943
944
  - [Get a patient photo](operations/patient.getPhoto.md) (`patient.getPhoto`)
944
945
  - [Get preferred pharmacy](operations/patient.getPreferredPharmacy.md) (`patient.getPreferredPharmacy`)
@@ -963,6 +964,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
963
964
  - [Search the knowledge base](operations/patient.searchKnowledge.md) (`patient.searchKnowledge`)
964
965
  - [Set preferred pharmacy](operations/patient.setPreferredPharmacy.md) (`patient.setPreferredPharmacy`)
965
966
  - [Submit current symptoms](operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md) (`patient.submitCurrentSymptomsScreeningsCurrentSymptoms`)
967
+ - [Submit patient-reported health record intake](operations/patient.submitPatientIntake.md) (`patient.submitPatientIntake`)
966
968
  - [Update home address](operations/patient.updateAddress.md) (`patient.updateAddress`)
967
969
  - [Update demographics](operations/patient.updateDemographics.md) (`patient.updateDemographics`)
968
970
  - [Update the patient's driver's license](operations/patient.updateDriversLicense.md) (`patient.updateDriversLicense`)
@@ -11,7 +11,7 @@ Type: `object`
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `allergen` | `string` | Yes | | | | No | Substance name (e.g. Penicillin, Peanut, Latex) |
14
- | `allergen_code` | [`CodedConcept`](./CodedConcept.md) | No | | | `null` | Yes | Coded allergen concept (SNOMED CT), when available. |
14
+ | `allergen_code` | [`ehr.CodedConcept`](./ehr.CodedConcept.md) | No | | | `null` | Yes | Coded allergen concept (SNOMED CT), when available. |
15
15
  | `allergy_id` | `string` | No | uuid | | | No | HealthCloud allergy identifier (UUID). |
16
16
  | `asserted_by` | `string|null` | No | | | `null` | Yes | Patient self-reported or provider name |
17
17
  | `asserted_date` | `string|null` | No | | | `null` | Yes | Date the allergy was asserted/recorded, when known. |
@@ -21,7 +21,7 @@ Type: `object`
21
21
  | `intolerance_type` | [`IntoleranceType`](./IntoleranceType.md) | No | | | `"allergy"` | No | Whether this is an allergy or an intolerance. |
22
22
  | `notes` | `string|null` | No | | | `null` | Yes | Free-text notes about the allergy, when present. |
23
23
  | `onset_date` | `string|null` | No | | | `null` | Yes | Date the allergy first onset, when known. |
24
- | `reactions` | array of [`AllergyReaction`](./AllergyReaction.md) | No | | | | No | Adverse reactions associated with the allergy. |
24
+ | `reactions` | array of [`ehr.AllergyReaction`](./ehr.AllergyReaction.md) | No | | | | No | Adverse reactions associated with the allergy. |
25
25
  | `resolved_date` | `string|null` | No | | | `null` | Yes | Date the allergy was resolved, when applicable. |
26
26
  | `status` | [`AllergyStatus`](./AllergyStatus.md) | No | | | `"active"` | No | Clinical status: active, inactive, resolved, or entered-in-error. |
27
27
  | `verification_status` | [`AllergyVerificationStatus`](./AllergyVerificationStatus.md) | No | | | `"confirmed"` | No | Verification status: unconfirmed, presumed, confirmed, refuted, or entered-in-error. |
@@ -14,7 +14,7 @@ Type: `object`
14
14
  | `biological` | `boolean` | No | | | `true` | No | Whether the family member is a biological relative. |
15
15
  | `born_date` | `string|null` | No | | | `null` | Yes | Birth date of the family member, when known. |
16
16
  | `cause_of_death` | `string|null` | No | | | `null` | Yes | Cause of death of the family member, when recorded. |
17
- | `conditions` | array of [`FamilyCondition`](./FamilyCondition.md) | No | | | | No | Conditions recorded for this family member. |
17
+ | `conditions` | array of [`ehr.FamilyCondition`](./ehr.FamilyCondition.md) | No | | | | No | Conditions recorded for this family member. |
18
18
  | `deceased` | `boolean|null` | No | | | `null` | Yes | Whether the family member is deceased, when known. |
19
19
  | `entry_id` | `string` | No | uuid | | | No | HealthCloud family-history entry identifier (UUID). |
20
20
  | `fhir_id` | `string|null` | No | | | `null` | Yes | FHIR FamilyMemberHistory resource id, when stored. |
@@ -11,7 +11,7 @@ Type: `object`
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `patient_id` | `string` | Yes | | | | No | Echoes the {patient_id} path parameter. |
14
- | `resources` | `object` | Yes | | | | No | Resources grouped by type (conditions, allergies, medications, procedures, immunizations, family_history, directives, encounters, vitals, questionnaire_responses, diagnostics). Core record collections are raw FHIR resources; encounters, questionnaire responses, diagnostics, and the vitals list are serialized service results. A resource type with a failed downstream fetch appears as an empty list, not an error. |
14
+ | `resources` | `object` | Yes | | | | No | Resources grouped by type (conditions, allergies, medications, procedures, immunizations, family_history, directives, encounters, vitals, questionnaire_responses, diagnostics, gyn_history, perinatal_history, intake_submissions). Gyn and perinatal history collections contain structured patient-reported FHIR Observations, also included in observations. Medications includes MedicationRequest and patient-reported MedicationStatement. intake_submissions lists this patient's raw intake submission records (same shape as the patient intake GET endpoint); it is also available individually from that endpoint by submission_id. Core record collections are raw FHIR resources; encounters, questionnaire responses, diagnostics, the vitals list, and intake_submissions are serialized service results. A resource type with a failed downstream fetch appears as an empty list, not an error. |
15
15
  | `totals` | `object` | Yes | | | | No | Count of records per resource type key in `resources`. |
16
16
 
17
17
  ## Example
@@ -0,0 +1,26 @@
1
+ # PatientIntakeRequest
2
+
3
+ Model ID: `PatientIntakeRequest`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `allergies` | `array|null` | No | | | | Yes | |
14
+ | `cancer_cases` | `array|null` | No | | | | Yes | |
15
+ | `family_history` | `array|null` | No | | | | Yes | |
16
+ | `gyn_history` | `array|null` | No | | | | Yes | |
17
+ | `medications` | `array|null` | No | | | | Yes | |
18
+ | `perinatal_history` | `array|null` | No | | | | Yes | |
19
+ | `problems` | `array|null` | No | | | | Yes | |
20
+ | `social_history` | `array|null` | No | | | | Yes | |
21
+ | `surgical_history` | `array|null` | No | | | | Yes | |
22
+ | `vaccines` | `array|null` | No | | | | Yes | |
23
+
24
+ ## Example
25
+
26
+ None declared in canonical OpenAPI.
@@ -0,0 +1,20 @@
1
+ # PatientIntakeResponse
2
+
3
+ Model ID: `PatientIntakeResponse`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `created_at` | `string` | Yes | date-time | | | No | |
14
+ | `storage_status` | `string` | Yes | | pending, saved, partial, failed | | No | |
15
+ | `submission_id` | `string` | Yes | uuid | | | No | |
16
+ | `vendors` | `object` | Yes | | | | No | |
17
+
18
+ ## Example
19
+
20
+ None declared in canonical OpenAPI.
@@ -1,6 +1,6 @@
1
1
  # AllergyReaction
2
2
 
3
- Model ID: `AllergyReaction`
3
+ Model ID: `ehr.AllergyReaction`
4
4
 
5
5
  No description.
6
6
 
@@ -11,7 +11,7 @@ Type: `object`
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `manifestation` | `string` | Yes | | | | No | e.g. Hives, Anaphylaxis, Nausea |
14
- | `manifestation_code` | [`CodedConcept`](./CodedConcept.md) | No | | | `null` | Yes | SNOMED-CT coded manifestation for FHIR |
14
+ | `manifestation_code` | [`ehr.CodedConcept`](./ehr.CodedConcept.md) | No | | | `null` | Yes | SNOMED-CT coded manifestation for FHIR |
15
15
  | `notes` | `string|null` | No | | | `null` | Yes | Free-text notes about the reaction, when present. |
16
16
  | `onset` | `string|null` | No | | | `null` | Yes | Date the reaction first occurred, when known. |
17
17
  | `severity` | [`ReactionSeverity`](./ReactionSeverity.md) | No | | | `null` | Yes | Severity of the reaction: mild, moderate, severe, or life_threatening. |
@@ -1,6 +1,6 @@
1
1
  # CodedConcept
2
2
 
3
- Model ID: `CodedConcept`
3
+ Model ID: `ehr.CodedConcept`
4
4
 
5
5
  A clinical concept identified by one or more coding systems.
6
6
 
@@ -1,6 +1,6 @@
1
1
  # FamilyCondition
2
2
 
3
- Model ID: `FamilyCondition`
3
+ Model ID: `ehr.FamilyCondition`
4
4
 
5
5
  No description.
6
6
 
@@ -15,6 +15,7 @@ Type: `object`
15
15
  | `condition` | `string` | Yes | | | | No | Name/description of the family member's condition. |
16
16
  | `icd10_code` | `string|null` | No | | | `null` | Yes | ICD-10-CM code for the condition, when coded. |
17
17
  | `notes` | `string|null` | No | | | `null` | Yes | Free-text notes about the condition, when present. |
18
+ | `snomed_code` | `string|null` | No | | | `null` | Yes | SNOMED CT code for the family member's condition, when known. |
18
19
 
19
20
  ## Example
20
21
 
@@ -16,7 +16,6 @@
16
16
  - [Allergy](Allergy.md)
17
17
  - [AllergyCategory](AllergyCategory.md)
18
18
  - [AllergyCriticality](AllergyCriticality.md)
19
- - [AllergyReaction](AllergyReaction.md)
20
19
  - [AllergyStatus](AllergyStatus.md)
21
20
  - [AllergyVerificationStatus](AllergyVerificationStatus.md)
22
21
  - [AnalyzeIdentityDocumentRequest](AnalyzeIdentityDocumentRequest.md)
@@ -392,7 +391,6 @@
392
391
  - [CmsGetCountyFipsRequest](CmsGetCountyFipsRequest.md)
393
392
  - [CmsSearchHealthPlansRequest](CmsSearchHealthPlansRequest.md)
394
393
  - [CmsSearchHealthPlansResponse](CmsSearchHealthPlansResponse.md)
395
- - [CodedConcept](CodedConcept.md)
396
394
  - [CommGroupRecord](CommGroupRecord.md)
397
395
  - [CommunicationsState](CommsGetStateResponse.md)
398
396
  - [CommsGetUnreadCountResponse](CommsGetUnreadCountResponse.md)
@@ -468,7 +466,10 @@
468
466
  - [DocumentSummarySearchResponse](DocumentSummarySearchResponse.md)
469
467
  - [DriversLicense](DriversLicense.md)
470
468
  - [DriversLicenseSubmission](DriversLicenseSubmission.md)
469
+ - [AllergyReaction](ehr.AllergyReaction.md)
470
+ - [CodedConcept](ehr.CodedConcept.md)
471
471
  - [ehr.ConnectResponse](ehr.ConnectResponse.md)
472
+ - [FamilyCondition](ehr.FamilyCondition.md)
472
473
  - [DiagnosticsListResponse](ehr.ListDiagnosticsResponse.md)
473
474
  - [EncounterListResponse](ehr.ListEncountersResponse.md)
474
475
  - [MedicationListResponse](ehr.ListMedicationsResponse.md)
@@ -518,7 +519,6 @@
518
519
  - [Ethnicity](Ethnicity.md)
519
520
  - [FaceMatchRequest](FaceMatchRequest.md)
520
521
  - [FaceMatchResponse](FaceMatchResponse.md)
521
- - [FamilyCondition](FamilyCondition.md)
522
522
  - [FamilyHistoryEntry](FamilyHistoryEntry.md)
523
523
  - [FamilyHistoryStatus](FamilyHistoryStatus.md)
524
524
  - [FamilyRelationship](FamilyRelationship.md)
@@ -1348,6 +1348,8 @@
1348
1348
  - [VerifySmsResponse](patient.VerifySmsResponse.md)
1349
1349
  - [PatientAlertsResponse](PatientAlertsResponse.md)
1350
1350
  - [PatientDemographics](PatientDemographics.md)
1351
+ - [PatientIntakeRequest](PatientIntakeRequest.md)
1352
+ - [PatientIntakeResponse](PatientIntakeResponse.md)
1351
1353
  - [PatientLink](PatientLink.md)
1352
1354
  - [PatientLinkType](PatientLinkType.md)
1353
1355
  - [PatientName](PatientName.md)
@@ -70,6 +70,7 @@ Request model: [`AthenaListMedicationsRequest`](../models/AthenaListMedicationsR
70
70
  {
71
71
  "created_by": "example-created-by",
72
72
  "events": [],
73
+ "is_discontinued": true,
73
74
  "medication_entry_id": "12345",
74
75
  "medication_id": "12345",
75
76
  "name": "Example Name",
@@ -60,32 +60,33 @@ None declared in canonical OpenAPI.
60
60
  {
61
61
  "family_history": [
62
62
  {
63
- "age_at_death": 78,
63
+ "age_at_death": 0,
64
64
  "biological": true,
65
- "born_date": "1945-05-10",
66
- "cause_of_death": "Cardiovascular disease",
65
+ "born_date": "2026-01-01",
66
+ "cause_of_death": "string",
67
67
  "conditions": [
68
68
  {
69
- "age_at_death": 78,
70
- "age_at_onset": 55,
71
- "condition": "Essential hypertension",
72
- "icd10_code": "I10",
73
- "notes": "Diagnosed in midlife"
69
+ "age_at_death": 0,
70
+ "age_at_onset": 0,
71
+ "condition": "string",
72
+ "icd10_code": "string",
73
+ "notes": "string",
74
+ "snomed_code": "string"
74
75
  }
75
76
  ],
76
77
  "deceased": true,
77
- "entry_id": "00000000-0000-4000-8000-000000000304",
78
- "fhir_id": "family-history-example-001",
79
- "member_name": "Jordan Smith",
80
- "notes": "Synthetic paternal history",
81
- "recorded_date": "2026-01-15",
82
- "relationship": "father",
83
- "sex": "male",
78
+ "entry_id": "00000000-0000-0000-0000-000000000000",
79
+ "fhir_id": "string",
80
+ "member_name": "string",
81
+ "notes": "string",
82
+ "recorded_date": "2026-01-01",
83
+ "relationship": "mother",
84
+ "sex": "string",
84
85
  "status": "completed"
85
86
  }
86
87
  ],
87
- "patient_id": "patient-example-001",
88
- "total": 1
88
+ "patient_id": "string",
89
+ "total": 0
89
90
  }
90
91
  ```
91
92
 
@@ -0,0 +1,137 @@
1
+ # Get own patient intake submission and delivery status
2
+
3
+ Operation ID: `patient.getPatientIntake`
4
+
5
+ Get own patient intake submission and delivery status
6
+
7
+ ## Public method
8
+
9
+ `getPatientIntake`
10
+
11
+ Signature: `patient.getPatientIntake(submissionId)`
12
+
13
+ Return type: `Promise<PatientIntakeResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `GET /patients/health-record/intake/{submission_id}`
28
+
29
+ ## Path parameters
30
+
31
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
32
+ |---|---|---:|---|---|---|---:|---|
33
+ | `submission_id` | `string` | Yes | | | | No | |
34
+
35
+ ## Query parameters
36
+
37
+ None.
38
+
39
+ ## Body parameters
40
+
41
+ None.
42
+
43
+ Request model: None.
44
+
45
+ ## Request example
46
+
47
+ None declared in canonical OpenAPI.
48
+
49
+ ## Success responses
50
+
51
+ | Status | Shape | Content type | Description |
52
+ |---|---|---|---|
53
+ | `200` | [`PatientIntakeResponse`](../models/PatientIntakeResponse.md) | application/json | Intake submission metadata and delivery status |
54
+
55
+ ## Success response examples
56
+
57
+ ### 200
58
+
59
+ ```json
60
+ {
61
+ "created_at": "2026-09-08T00:00:00Z",
62
+ "storage_status": "saved",
63
+ "submission_id": "9c9aa3d0-fc18-4bc8-9bbf-2f465f310e5e",
64
+ "vendors": {
65
+ "athena": {
66
+ "mode": "unsupported",
67
+ "reason": "Vendor is not enabled for this tenant",
68
+ "reference": null,
69
+ "section_results": {},
70
+ "sections": [
71
+ "allergies"
72
+ ],
73
+ "status": "not_configured"
74
+ },
75
+ "openloop": {
76
+ "mode": "unsupported",
77
+ "reason": "Vendor is not enabled for this tenant",
78
+ "reference": null,
79
+ "section_results": {},
80
+ "sections": [
81
+ "allergies"
82
+ ],
83
+ "status": "not_configured"
84
+ },
85
+ "steadymd": {
86
+ "mode": "unsupported",
87
+ "reason": "Vendor is not enabled for this tenant",
88
+ "reference": null,
89
+ "section_results": {},
90
+ "sections": [
91
+ "allergies"
92
+ ],
93
+ "status": "not_configured"
94
+ }
95
+ }
96
+ }
97
+ ```
98
+
99
+ ## Common errors
100
+
101
+ None declared in canonical OpenAPI.
102
+
103
+ ## Error examples
104
+
105
+ None declared in canonical OpenAPI.
106
+
107
+ ## NodeJS / TypeScript implementation
108
+
109
+ ```ts
110
+ import { HCSDK } from "@healthcloudai/hc-sdk";
111
+ ```
112
+
113
+ ```ts
114
+ const submissionId = "<SUBMISSION_ID>";
115
+
116
+ const result = await patient.getPatientIntake(submissionId);
117
+ ```
118
+
119
+ ## cURL
120
+
121
+ ```bash
122
+ curl -X GET \
123
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
124
+ 'https://dev-api-patient.health.cloud/patients/health-record/intake/%3CSUBMISSION_ID%3E'
125
+ ```
126
+
127
+ ## Notes
128
+
129
+ None.
130
+
131
+ ## Prepared Test Console scenario
132
+
133
+ No canonical scenario is currently associated.
134
+
135
+ ## Real response
136
+
137
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.