Changelog
Release history for the Vim Connect Backend SDK
The SDK is published to npm as @vimconnect/backend-sdk.
Every release below changed the SDK's public type surface: the operations on client.api, the
entity types, the exports and the client options your server compiles against. Releases that
changed only internals are not listed.
| Label | What it means for you |
|---|---|
| New feature | Names were added. Existing code keeps compiling; adopt the new names when you need them. |
| Breaking change | A name was removed or renamed. Your code stops compiling until you update it. |
| Initial release | The first version on npm. Lists how much of the surface it shipped. |
Every line links to the reference page that documents that part of the SDK: operations, entity types, exports and client options.
v0.2.3 — 2026-10-15
New feature- Exports — added
VaultApi,VaultArtifactApi,VaultArtifactCreateParams,VaultArtifactCreateResult,VaultArtifactDownload,VaultArtifactMetadata,VaultArtifactUploadParams,VaultArtifactUploadResult,VaultPatientApi,VaultPatientIdentity,VaultPatientPayload,VaultPatientRecord,VaultTokenMetadata,VaultTokenizeResult - Client options — added
ehrResultSecret,uploadTimeoutMs
v0.2.1 — 2026-10-13
New feature- Exports — added
AddressSchema,AdtInsightSchema,AllergySchema,CcmInsightSchema,ClinicalInsightSchema,ContactInfoSchema,CustomFieldSchema,DemographicsSchema,DiagnosisGapSchema,DiagnosisSchema,HccGapSchema,IcdGapSchema,InsuranceSchema,LabResultSchema,LastRecordedSchema,LookupIdentifiersSchema,LookupPayloadSchema,LookupStatusDetailsSchema,MatchStatusDetailsSchema,MedicalCodeSchema,MedicationBasicInformationSchema,MedicationSchema,PatientLookupSchema,PatientMatchSchema,PatientSchema,ProcedureSchema,ProviderDemographicsSchema,ProviderSchema,QualityGapSchema,QuantitySchema,RiskInsightSchema,RxInsightSchema,RxRecommendationSchema,SdohInsightSchema,SupportingDocumentSchema,UtilizationInsightSchema,VitalSchema
v0.2.0 — 2026-10-13
Breaking changepatient.lookup and patient.getInsights now answer { records }, getInsights takes { vimEntityId }, and client.ehr gains its first operations. The *Schema names are gone because the package never exported them, so they were undefined at runtime; use the type of the same name without the suffix, such as Patient.
- Entity types — added
ProviderDemographics - Exports — added
CustomOperationResponse,CustomRecord,EHR_OPERATIONS,EhrAccessErrorCode,EhrAccessMode,EhrCallOptions,EhrClient,EhrErrorCode,EhrOperation,EhrOperationBinding,EhrStartOptions,EhrStartedTask,EhrSystemsResponse,EhrWaitOptions,EntityStoreOperationBinding,ProviderDemographics,VimConnectEhrError,VimConnectEhrErrorOptions,existingRecordIdOf,isRetryable; removedAddressSchema,AdtInsightSchema,AllergySchema,CcmInsightSchema,ClinicalInsightSchema,ContactInfoSchema,CustomFieldSchema,DemographicsSchema,DiagnosisGapSchema,DiagnosisSchema,HccGapSchema,IcdGapSchema,InsightsResponse,InsuranceSchema,LabResultSchema,LastRecordedSchema,LookupIdentifiersSchema,LookupPayloadSchema,LookupResponse,LookupStatusDetailsSchema,MatchStatusDetailsSchema,MedicalCodeSchema,MedicationBasicInformationSchema,MedicationSchema,OPERATION_TYPE_IS_RETRYABLE,PatientLookupSchema,PatientMatchSchema,PatientSchema,ProcedureSchema,ProviderSchema,QualityGapSchema,QuantitySchema,RiskInsightSchema,RxInsightSchema,RxRecommendationSchema,SdohInsightSchema,SupportingDocumentSchema,UtilizationInsightSchema,VitalSchema
v0.1.0 — 2026-10-08
Initial releaseFirst release of the server-side SDK: typed client.api operations for the records your service app was granted, with PHI tokenized before writes and revealed after reads.
- Operations — 41
- Entity types — 36
- Exports — 151
- Client options — 8
Read 5 of the 5 SDK versions published up to 0.2.3 (2026-10-15); 3 changed the public type surface.