@medplum/ccda 3.3.0 → 4.0.1

package/dist/cjs/index.d.ts

@@ -1,5 +1,6 @@
 import { Bundle } from '@medplum/fhirtypes';
 import { CodeableConcept } from '@medplum/fhirtypes';
+import { Coding } from '@medplum/fhirtypes';
 
 export declare const ACT_CODE_SYSTEM = "http://terminology.hl7.org/CodeSystem/v3-ActCode";
 
@@ -11,6 +12,8 @@ export declare const ADMINISTRATIVE_GENDER_VALUE_SET = "http://hl7.org/fhir/Valu
 
 export declare const ALLERGIES_SECTION_TEMPLATE_IDS: CcdaTemplateId[];
 
+export declare const ALLERGY_CATEGORY_MAPPER: EnumMapper<string, string>;
+
 export declare const ALLERGY_CLINICAL_CODE_SYSTEM = "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical";
 
 export declare const ALLERGY_SEVERITY_MAPPER: EnumMapper<"moderate" | "mild" | "severe", string>;
@@ -58,7 +61,7 @@ export declare interface CcdaAct {
     templateId: CcdaTemplateId[];
     id?: CcdaId[];
     code: CcdaCode;
-    statusCode: CcdaStatusCode;
+    statusCode: CcdaCode;
     effectiveTime?: CcdaEffectiveTime[];
     entryRelationship?: CcdaEntryRelationship[];
     author?: CcdaAuthor[];
@@ -107,13 +110,14 @@ export declare interface CcdaAuthor {
     assignedAuthor?: CcdaAssignedAuthor;
 }
 
-export declare interface CcdaCode {
+export declare interface CcdaCode<T extends string = string> {
     '@_xsi:type'?: 'CD' | 'CE';
-    '@_code'?: string;
+    '@_code'?: T;
     '@_codeSystem'?: string;
     '@_codeSystemName'?: string;
     '@_displayName'?: string;
     originalText?: CcdaText;
+    translation?: CcdaCode[];
 }
 
 export declare interface CcdaConsumable {
@@ -130,7 +134,7 @@ export declare interface CcdaDocumentationOf {
 }
 
 export declare interface CcdaEffectiveTime {
-    '@_xsi:type'?: 'IVL_TS' | 'TS';
+    '@_xsi:type'?: 'IVL_TS' | 'TS' | 'PIVL_TS';
     '@_institutionSpecified'?: string;
     '@_operator'?: string;
     '@_value'?: string;
@@ -146,7 +150,7 @@ export declare interface CcdaEncounter {
     templateId: CcdaTemplateId[];
     id?: CcdaId[];
     code?: CcdaCode;
-    statusCode?: CcdaStatusCode<'active' | 'completed' | 'aborted' | 'cancelled' | 'unknown'>;
+    statusCode?: CcdaCode<'active' | 'completed' | 'aborted' | 'cancelled' | 'unknown'>;
     effectiveTime?: CcdaEffectiveTime[];
     performer?: CcdaPerformer[];
     participant?: CcdaParticipant[];
@@ -217,7 +221,7 @@ export declare interface CcdaManufacturerOrganization {
 }
 
 export declare interface CcdaName {
-    '@_use'?: 'ANON' | 'C' | 'L' | 'M' | 'N' | 'TEMP';
+    '@_use'?: 'ANON' | 'C' | 'L' | 'P' | 'TEMP';
     family?: string;
     given?: string[];
     suffix?: string[];
@@ -232,7 +236,7 @@ export declare interface CcdaObservation {
     templateId: CcdaTemplateId[];
     id?: CcdaId[];
     code?: CcdaCode;
-    statusCode: CcdaStatusCode;
+    statusCode: CcdaCode;
     effectiveTime?: CcdaEffectiveTime[];
     value?: CcdaValue;
     participant?: CcdaParticipant[];
@@ -253,7 +257,7 @@ export declare interface CcdaOrganizer {
     templateId: CcdaTemplateId[];
     id: CcdaId[];
     code?: CcdaCode;
-    statusCode?: CcdaStatusCode;
+    statusCode?: CcdaCode;
     effectiveTime?: CcdaEffectiveTime[];
     component: CcdaOrganizerComponent[];
 }
@@ -276,6 +280,11 @@ export declare interface CcdaParticipant {
 export declare interface CcdaParticipantRole {
     '@_classCode'?: string;
     '@_typeCode'?: string;
+    templateId?: CcdaTemplateId[];
+    id?: CcdaId[];
+    code?: CcdaCode;
+    addr?: CcdaAddr[];
+    telecom?: CcdaTelecom[];
     playingEntity?: CcdaPlayingEntity;
 }
 
@@ -303,14 +312,15 @@ export declare interface CcdaPerformer {
 
 export declare interface CcdaPeriod {
     '@_xsi:type'?: 'PIVL_TS';
-    '@_value': string;
-    '@_unit': string;
+    '@_value'?: string;
+    '@_unit'?: 's' | 'min' | 'h' | 'd' | 'wk' | 'mo' | 'a';
 }
 
 export declare interface CcdaPlayingEntity {
     '@_classCode'?: string;
     '@_typeCode'?: string;
     code?: CcdaCode;
+    name?: string[];
 }
 
 export declare interface CcdaProcedure {
@@ -319,11 +329,12 @@ export declare interface CcdaProcedure {
     templateId: CcdaTemplateId[];
     id?: CcdaId[];
     code: CcdaCode;
-    statusCode: CcdaStatusCode<'completed' | 'aborted' | 'cancelled' | 'new' | 'unknown'>;
+    statusCode: CcdaCode<'completed' | 'aborted' | 'cancelled' | 'new' | 'unknown'>;
     effectiveTime?: CcdaEffectiveTime[];
     methodCode?: CcdaCode;
     targetSiteCode?: CcdaCode;
     text?: CcdaText;
+    participant?: CcdaParticipant[];
 }
 
 export declare interface CcdaQuantity {
@@ -379,10 +390,6 @@ export declare interface CcdaServiceEvent {
     effectiveTime?: CcdaEffectiveTime[];
 }
 
-export declare interface CcdaStatusCode<T extends string = string> {
-    '@_code': T;
-}
-
 export declare interface CcdaStructuredBody {
     component: CcdaInnerComponent[];
 }
@@ -393,8 +400,8 @@ export declare interface CcdaSubstanceAdministration {
     '@_negationInd'?: string;
     templateId: CcdaTemplateId[];
     id?: CcdaId[];
-    text?: CcdaText;
-    statusCode?: CcdaStatusCode<'active' | 'completed' | 'aborted' | 'cancelled'>;
+    text?: string | CcdaText;
+    statusCode?: CcdaCode<'active' | 'completed' | 'aborted' | 'cancelled' | 'nullified' | 'obsolete'>;
     effectiveTime?: CcdaEffectiveTime[];
     routeCode?: CcdaCode;
     doseQuantity?: CcdaQuantity;
@@ -441,7 +448,7 @@ export declare const CONDITION_VERIFICATION_CODE_SYSTEM = "http://terminology.hl
 
 export declare const CONFIDENTIALITY_CODE_SYSTEM = "http://terminology.hl7.org/CodeSystem/v3-Confidentiality";
 
-export declare const CONFIDENTIALITY_MAPPER: EnumMapper<"L" | "M" | "N" | "U" | "R" | "V", "L" | "M" | "N" | "U" | "R" | "V">;
+export declare const CONFIDENTIALITY_MAPPER: EnumMapper<"L" | "U" | "M" | "N" | "R" | "V", "L" | "U" | "M" | "N" | "R" | "V">;
 
 export declare const CONTACT_ENTITY_USE_VALUE_SET = "http://hl7.org/fhir/ValueSet/contactentity-use";
 
@@ -495,12 +502,13 @@ export declare class EnumMapper<TFhirValue extends string, TCcdaValue extends st
     readonly fhirToCcdaMap: Record<TFhirValue, EnumEntry<TFhirValue, TCcdaValue>>;
     constructor(systemName: string, ccdaSystemOid: string, fhirSystemUrl: string, entries: EnumEntry<TFhirValue, TCcdaValue>[]);
     getEntryByFhir(fhir: TFhirValue): EnumEntry<TFhirValue, TCcdaValue> | undefined;
+    getEntryByCcda(ccda: TCcdaValue): EnumEntry<TFhirValue, TCcdaValue> | undefined;
     mapCcdaToFhir(ccda: TCcdaValue): TFhirValue | undefined;
     mapCcdaToFhirWithDefault(ccda: TCcdaValue | undefined, defaultValue: TFhirValue): TFhirValue;
     mapFhirToCcdaWithDefault(fhir: TFhirValue | undefined, defaultValue: TCcdaValue): TCcdaValue;
     mapCcdaToFhirCodeableConcept(ccda: TCcdaValue): CodeableConcept | undefined;
     mapFhirToCcda(fhir: TFhirValue | undefined): TCcdaValue | undefined;
-    mapFhirToCcdaCode(fhir: TFhirValue | undefined): CcdaCode | undefined;
+    mapFhirToCcdaCode(fhir: TFhirValue | undefined): CcdaCode<TCcdaValue> | undefined;
 }
 
 export declare const FHIR_CVX_URL = "http://hl7.org/fhir/sid/cvx";
@@ -518,7 +526,9 @@ export declare const HEALTH_CONCERNS_SECTION_TEMPLATE_IDS: CcdaTemplateId[];
  */
 export declare const HTTP = "http:";
 
-export declare const HUMAN_NAME_USE_MAPPER: EnumMapper<"usual" | "official" | "temp" | "nickname" | "anonymous" | "maiden" | "old", "ANON" | "C" | "L" | "M" | "N" | "TEMP">;
+export declare const HUMAN_NAME_USE_MAPPER: EnumMapper<"usual" | "official" | "temp" | "nickname" | "anonymous" | "maiden" | "old", "ANON" | "C" | "L" | "P" | "TEMP">;
+
+export declare const IMMUNIZATION_STATUS_MAPPER: EnumMapper<"completed" | "entered-in-error" | "not-done", "active" | "completed" | "aborted" | "cancelled" | "nullified" | "obsolete">;
 
 export declare const IMMUNIZATIONS_SECTION_TEMPLATE_IDS: CcdaTemplateId[];
 
@@ -571,6 +581,13 @@ export declare function mapCodeableConceptToCcdaCode(codeableConcept: CodeableCo
  */
 export declare function mapCodeableConceptToCcdaValue(codeableConcept: CodeableConcept | undefined): CcdaValue | undefined;
 
+/**
+ * Map the FHIR coding to the C-CDA code.
+ * @param coding - The FHIR coding to map.
+ * @returns The C-CDA code.
+ */
+export declare function mapCodingToCcdaCode(coding: Coding): CcdaCode;
+
 /**
  * Map the FHIR system to the C-CDA system.
  * @param system - The system to map.
@@ -594,7 +611,7 @@ export declare function mapFhirToCcdaDateTime(dateTime: string | undefined): str
 
 export declare const MEDICATION_REQUEST_STATUS_VALUE_SET = "http://hl7.org/fhir/ValueSet/medicationrequest-status";
 
-export declare const MEDICATION_STATUS_MAPPER: EnumMapper<Required<"active" | "completed" | "cancelled" | "unknown" | "entered-in-error" | "stopped" | "on-hold" | "draft">, "active" | "completed" | "aborted" | "cancelled">;
+export declare const MEDICATION_STATUS_MAPPER: EnumMapper<Required<"active" | "completed" | "cancelled" | "unknown" | "entered-in-error" | "stopped" | "on-hold" | "draft">, "active" | "completed" | "aborted" | "cancelled" | "nullified" | "obsolete">;
 
 export declare const MEDICATIONS_SECTION_TEMPLATE_IDS: CcdaTemplateId[];
 
@@ -624,7 +641,7 @@ export declare const PROBLEM_STATUS_MAPPER: EnumMapper<string, string>;
 
 export declare const PROBLEMS_SECTION_TEMPLATE_IDS: CcdaTemplateId[];
 
-export declare const PROCEDURE_STATUS_MAPPER: EnumMapper<"completed" | "unknown" | "stopped" | "not-done", "completed" | "aborted" | "cancelled" | "unknown" | "new">;
+export declare const PROCEDURE_STATUS_MAPPER: EnumMapper<"completed" | "unknown" | "not-done" | "stopped", "completed" | "aborted" | "cancelled" | "unknown" | "new">;
 
 export declare const PROCEDURES_SECTION_TEMPLATE_IDS: CcdaTemplateId[];
 

package/dist/esm/index.d.ts

@@ -1,5 +1,6 @@
 import { Bundle } from '@medplum/fhirtypes';
 import { CodeableConcept } from '@medplum/fhirtypes';
+import { Coding } from '@medplum/fhirtypes';
 
 export declare const ACT_CODE_SYSTEM = "http://terminology.hl7.org/CodeSystem/v3-ActCode";
 
@@ -11,6 +12,8 @@ export declare const ADMINISTRATIVE_GENDER_VALUE_SET = "http://hl7.org/fhir/Valu
 
 export declare const ALLERGIES_SECTION_TEMPLATE_IDS: CcdaTemplateId[];
 
+export declare const ALLERGY_CATEGORY_MAPPER: EnumMapper<string, string>;
+
 export declare const ALLERGY_CLINICAL_CODE_SYSTEM = "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical";
 
 export declare const ALLERGY_SEVERITY_MAPPER: EnumMapper<"moderate" | "mild" | "severe", string>;
@@ -58,7 +61,7 @@ export declare interface CcdaAct {
     templateId: CcdaTemplateId[];
     id?: CcdaId[];
     code: CcdaCode;
-    statusCode: CcdaStatusCode;
+    statusCode: CcdaCode;
     effectiveTime?: CcdaEffectiveTime[];
     entryRelationship?: CcdaEntryRelationship[];
     author?: CcdaAuthor[];
@@ -107,13 +110,14 @@ export declare interface CcdaAuthor {
     assignedAuthor?: CcdaAssignedAuthor;
 }
 
-export declare interface CcdaCode {
+export declare interface CcdaCode<T extends string = string> {
     '@_xsi:type'?: 'CD' | 'CE';
-    '@_code'?: string;
+    '@_code'?: T;
     '@_codeSystem'?: string;
     '@_codeSystemName'?: string;
     '@_displayName'?: string;
     originalText?: CcdaText;
+    translation?: CcdaCode[];
 }
 
 export declare interface CcdaConsumable {
@@ -130,7 +134,7 @@ export declare interface CcdaDocumentationOf {
 }
 
 export declare interface CcdaEffectiveTime {
-    '@_xsi:type'?: 'IVL_TS' | 'TS';
+    '@_xsi:type'?: 'IVL_TS' | 'TS' | 'PIVL_TS';
     '@_institutionSpecified'?: string;
     '@_operator'?: string;
     '@_value'?: string;
@@ -146,7 +150,7 @@ export declare interface CcdaEncounter {
     templateId: CcdaTemplateId[];
     id?: CcdaId[];
     code?: CcdaCode;
-    statusCode?: CcdaStatusCode<'active' | 'completed' | 'aborted' | 'cancelled' | 'unknown'>;
+    statusCode?: CcdaCode<'active' | 'completed' | 'aborted' | 'cancelled' | 'unknown'>;
     effectiveTime?: CcdaEffectiveTime[];
     performer?: CcdaPerformer[];
     participant?: CcdaParticipant[];
@@ -217,7 +221,7 @@ export declare interface CcdaManufacturerOrganization {
 }
 
 export declare interface CcdaName {
-    '@_use'?: 'ANON' | 'C' | 'L' | 'M' | 'N' | 'TEMP';
+    '@_use'?: 'ANON' | 'C' | 'L' | 'P' | 'TEMP';
     family?: string;
     given?: string[];
     suffix?: string[];
@@ -232,7 +236,7 @@ export declare interface CcdaObservation {
     templateId: CcdaTemplateId[];
     id?: CcdaId[];
     code?: CcdaCode;
-    statusCode: CcdaStatusCode;
+    statusCode: CcdaCode;
     effectiveTime?: CcdaEffectiveTime[];
     value?: CcdaValue;
     participant?: CcdaParticipant[];
@@ -253,7 +257,7 @@ export declare interface CcdaOrganizer {
     templateId: CcdaTemplateId[];
     id: CcdaId[];
     code?: CcdaCode;
-    statusCode?: CcdaStatusCode;
+    statusCode?: CcdaCode;
     effectiveTime?: CcdaEffectiveTime[];
     component: CcdaOrganizerComponent[];
 }
@@ -276,6 +280,11 @@ export declare interface CcdaParticipant {
 export declare interface CcdaParticipantRole {
     '@_classCode'?: string;
     '@_typeCode'?: string;
+    templateId?: CcdaTemplateId[];
+    id?: CcdaId[];
+    code?: CcdaCode;
+    addr?: CcdaAddr[];
+    telecom?: CcdaTelecom[];
     playingEntity?: CcdaPlayingEntity;
 }
 
@@ -303,14 +312,15 @@ export declare interface CcdaPerformer {
 
 export declare interface CcdaPeriod {
     '@_xsi:type'?: 'PIVL_TS';
-    '@_value': string;
-    '@_unit': string;
+    '@_value'?: string;
+    '@_unit'?: 's' | 'min' | 'h' | 'd' | 'wk' | 'mo' | 'a';
 }
 
 export declare interface CcdaPlayingEntity {
     '@_classCode'?: string;
     '@_typeCode'?: string;
     code?: CcdaCode;
+    name?: string[];
 }
 
 export declare interface CcdaProcedure {
@@ -319,11 +329,12 @@ export declare interface CcdaProcedure {
     templateId: CcdaTemplateId[];
     id?: CcdaId[];
     code: CcdaCode;
-    statusCode: CcdaStatusCode<'completed' | 'aborted' | 'cancelled' | 'new' | 'unknown'>;
+    statusCode: CcdaCode<'completed' | 'aborted' | 'cancelled' | 'new' | 'unknown'>;
     effectiveTime?: CcdaEffectiveTime[];
     methodCode?: CcdaCode;
     targetSiteCode?: CcdaCode;
     text?: CcdaText;
+    participant?: CcdaParticipant[];
 }
 
 export declare interface CcdaQuantity {
@@ -379,10 +390,6 @@ export declare interface CcdaServiceEvent {
     effectiveTime?: CcdaEffectiveTime[];
 }
 
-export declare interface CcdaStatusCode<T extends string = string> {
-    '@_code': T;
-}
-
 export declare interface CcdaStructuredBody {
     component: CcdaInnerComponent[];
 }
@@ -393,8 +400,8 @@ export declare interface CcdaSubstanceAdministration {
     '@_negationInd'?: string;
     templateId: CcdaTemplateId[];
     id?: CcdaId[];
-    text?: CcdaText;
-    statusCode?: CcdaStatusCode<'active' | 'completed' | 'aborted' | 'cancelled'>;
+    text?: string | CcdaText;
+    statusCode?: CcdaCode<'active' | 'completed' | 'aborted' | 'cancelled' | 'nullified' | 'obsolete'>;
     effectiveTime?: CcdaEffectiveTime[];
     routeCode?: CcdaCode;
     doseQuantity?: CcdaQuantity;
@@ -441,7 +448,7 @@ export declare const CONDITION_VERIFICATION_CODE_SYSTEM = "http://terminology.hl
 
 export declare const CONFIDENTIALITY_CODE_SYSTEM = "http://terminology.hl7.org/CodeSystem/v3-Confidentiality";
 
-export declare const CONFIDENTIALITY_MAPPER: EnumMapper<"L" | "M" | "N" | "U" | "R" | "V", "L" | "M" | "N" | "U" | "R" | "V">;
+export declare const CONFIDENTIALITY_MAPPER: EnumMapper<"L" | "U" | "M" | "N" | "R" | "V", "L" | "U" | "M" | "N" | "R" | "V">;
 
 export declare const CONTACT_ENTITY_USE_VALUE_SET = "http://hl7.org/fhir/ValueSet/contactentity-use";
 
@@ -495,12 +502,13 @@ export declare class EnumMapper<TFhirValue extends string, TCcdaValue extends st
     readonly fhirToCcdaMap: Record<TFhirValue, EnumEntry<TFhirValue, TCcdaValue>>;
     constructor(systemName: string, ccdaSystemOid: string, fhirSystemUrl: string, entries: EnumEntry<TFhirValue, TCcdaValue>[]);
     getEntryByFhir(fhir: TFhirValue): EnumEntry<TFhirValue, TCcdaValue> | undefined;
+    getEntryByCcda(ccda: TCcdaValue): EnumEntry<TFhirValue, TCcdaValue> | undefined;
     mapCcdaToFhir(ccda: TCcdaValue): TFhirValue | undefined;
     mapCcdaToFhirWithDefault(ccda: TCcdaValue | undefined, defaultValue: TFhirValue): TFhirValue;
     mapFhirToCcdaWithDefault(fhir: TFhirValue | undefined, defaultValue: TCcdaValue): TCcdaValue;
     mapCcdaToFhirCodeableConcept(ccda: TCcdaValue): CodeableConcept | undefined;
     mapFhirToCcda(fhir: TFhirValue | undefined): TCcdaValue | undefined;
-    mapFhirToCcdaCode(fhir: TFhirValue | undefined): CcdaCode | undefined;
+    mapFhirToCcdaCode(fhir: TFhirValue | undefined): CcdaCode<TCcdaValue> | undefined;
 }
 
 export declare const FHIR_CVX_URL = "http://hl7.org/fhir/sid/cvx";
@@ -518,7 +526,9 @@ export declare const HEALTH_CONCERNS_SECTION_TEMPLATE_IDS: CcdaTemplateId[];
  */
 export declare const HTTP = "http:";
 
-export declare const HUMAN_NAME_USE_MAPPER: EnumMapper<"usual" | "official" | "temp" | "nickname" | "anonymous" | "maiden" | "old", "ANON" | "C" | "L" | "M" | "N" | "TEMP">;
+export declare const HUMAN_NAME_USE_MAPPER: EnumMapper<"usual" | "official" | "temp" | "nickname" | "anonymous" | "maiden" | "old", "ANON" | "C" | "L" | "P" | "TEMP">;
+
+export declare const IMMUNIZATION_STATUS_MAPPER: EnumMapper<"completed" | "entered-in-error" | "not-done", "active" | "completed" | "aborted" | "cancelled" | "nullified" | "obsolete">;
 
 export declare const IMMUNIZATIONS_SECTION_TEMPLATE_IDS: CcdaTemplateId[];
 
@@ -571,6 +581,13 @@ export declare function mapCodeableConceptToCcdaCode(codeableConcept: CodeableCo
  */
 export declare function mapCodeableConceptToCcdaValue(codeableConcept: CodeableConcept | undefined): CcdaValue | undefined;
 
+/**
+ * Map the FHIR coding to the C-CDA code.
+ * @param coding - The FHIR coding to map.
+ * @returns The C-CDA code.
+ */
+export declare function mapCodingToCcdaCode(coding: Coding): CcdaCode;
+
 /**
  * Map the FHIR system to the C-CDA system.
  * @param system - The system to map.
@@ -594,7 +611,7 @@ export declare function mapFhirToCcdaDateTime(dateTime: string | undefined): str
 
 export declare const MEDICATION_REQUEST_STATUS_VALUE_SET = "http://hl7.org/fhir/ValueSet/medicationrequest-status";
 
-export declare const MEDICATION_STATUS_MAPPER: EnumMapper<Required<"active" | "completed" | "cancelled" | "unknown" | "entered-in-error" | "stopped" | "on-hold" | "draft">, "active" | "completed" | "aborted" | "cancelled">;
+export declare const MEDICATION_STATUS_MAPPER: EnumMapper<Required<"active" | "completed" | "cancelled" | "unknown" | "entered-in-error" | "stopped" | "on-hold" | "draft">, "active" | "completed" | "aborted" | "cancelled" | "nullified" | "obsolete">;
 
 export declare const MEDICATIONS_SECTION_TEMPLATE_IDS: CcdaTemplateId[];
 
@@ -624,7 +641,7 @@ export declare const PROBLEM_STATUS_MAPPER: EnumMapper<string, string>;
 
 export declare const PROBLEMS_SECTION_TEMPLATE_IDS: CcdaTemplateId[];
 
-export declare const PROCEDURE_STATUS_MAPPER: EnumMapper<"completed" | "unknown" | "stopped" | "not-done", "completed" | "aborted" | "cancelled" | "unknown" | "new">;
+export declare const PROCEDURE_STATUS_MAPPER: EnumMapper<"completed" | "unknown" | "not-done" | "stopped", "completed" | "aborted" | "cancelled" | "unknown" | "new">;
 
 export declare const PROCEDURES_SECTION_TEMPLATE_IDS: CcdaTemplateId[];