@medplum/ccda 5.0.13 → 5.0.15
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/README.md +22 -28
- package/dist/cjs/index.cjs +2 -2
- package/dist/cjs/index.cjs.map +4 -4
- package/dist/cjs/index.d.ts +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.mjs +2 -2
- package/dist/esm/index.mjs.map +4 -4
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -8,20 +8,15 @@ The `@medplum/ccda` package enables seamless conversion between C-CDA and FHIR,
|
|
|
8
8
|
|
|
9
9
|
**Key Features:**
|
|
10
10
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
11
|
+
- **C-CDA to FHIR:** Convert a C-CDA document to a FHIR Composition bundle using the `convertCcdaToFhir` function.
|
|
12
|
+
- **FHIR to C-CDA:** Convert a FHIR Composition bundle to a C-CDA document using the `convertFhirToCcda` function.
|
|
13
|
+
- **XML Parsing:** Load a C-CDA document from an XML string using the `convertXmlToCcda` function.
|
|
14
|
+
- **XML Serialization:** Serialize a C-CDA document to an XML string using the `convertCcdaToXml` function.
|
|
15
15
|
|
|
16
16
|
## Usage
|
|
17
17
|
|
|
18
18
|
```typescript
|
|
19
|
-
import {
|
|
20
|
-
convertCcdaToFhir,
|
|
21
|
-
convertFhirToCcda,
|
|
22
|
-
convertXmlToCcda,
|
|
23
|
-
convertCcdaToXml,
|
|
24
|
-
} from '@medplum/ccda';
|
|
19
|
+
import { convertCcdaToFhir, convertFhirToCcda, convertXmlToCcda, convertCcdaToXml } from '@medplum/ccda';
|
|
25
20
|
|
|
26
21
|
// Convert C-CDA to FHIR
|
|
27
22
|
const bundle = convertCcdaToFhir(ccda);
|
|
@@ -40,12 +35,12 @@ const xml = convertCcdaToXml(ccda);
|
|
|
40
35
|
|
|
41
36
|
This library is designed to elegantly integrate the following standards and specifications:
|
|
42
37
|
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
38
|
+
- **FHIR R4:** The underlying data model for representing healthcare resources.
|
|
39
|
+
- **US Core:** A set of FHIR profiles and extensions for US healthcare interoperability.
|
|
40
|
+
- **USCDI:** The United States Core Data for Interoperability, defining a standardized set of health data classes and elements.
|
|
41
|
+
- **International Patient Summary (IPS):** A FHIR-based standard for exchanging patient summaries.
|
|
42
|
+
- **HL7 C-CDA:** A widely used standard for clinical document exchange.
|
|
43
|
+
- **C-CDA R2.1 for USCDI v3:** A specific implementation of C-CDA aligned with the USCDI v3 standard.
|
|
49
44
|
|
|
50
45
|
By aligning with these standards, this library ensures that C-CDA documents can be effectively converted to and from FHIR, enabling interoperability with modern healthcare systems and applications.
|
|
51
46
|
|
|
@@ -53,25 +48,24 @@ By aligning with these standards, this library ensures that C-CDA documents can
|
|
|
53
48
|
|
|
54
49
|
In addition to the core conversion functions, Medplum provides FHIR server operations for seamless C-CDA import and export:
|
|
55
50
|
|
|
56
|
-
|
|
57
|
-
|
|
51
|
+
- **`Patient/{id}/$ccda-import`:** Imports a C-CDA document and updates the corresponding patient record.
|
|
52
|
+
- **`Patient/{id}/$ccda-export`:** Exports a patient's data as a C-CDA document.
|
|
58
53
|
|
|
59
54
|
These operations are documented in the Medplum FHIR server documentation.
|
|
60
55
|
|
|
61
56
|
## Additional Notes
|
|
62
57
|
|
|
63
|
-
|
|
64
|
-
|
|
58
|
+
- This library is actively maintained and updated to support the latest versions of FHIR, US Core, and C-CDA standards.
|
|
59
|
+
- Contributions and feedback are welcome! Please submit issues or pull requests on GitHub.
|
|
65
60
|
|
|
66
61
|
**Links:**
|
|
67
62
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
63
|
+
- [Medplum FHIR Server Documentation](https://www.medplum.com/docs/api/fhir)
|
|
64
|
+
- [FHIR R4 Specification](https://hl7.org/fhir/R4/)
|
|
65
|
+
- [US Core Implementation Guide](https://www.hl7.org/fhir/us/core/)
|
|
66
|
+
- [USCDI Website](https://www.healthit.gov/isp/united-states-core-data-interoperability-uscdi)
|
|
67
|
+
- [International Patient Summary Implementation Guide](https://build.fhir.org/ig/HL7/fhir-ips/)
|
|
68
|
+
- [HL7 C-CDA Standard](https://hl7.org/cda/us/ccda/3.0.0/)
|
|
75
69
|
|
|
76
70
|
## About Medplum
|
|
77
71
|
|
|
@@ -79,4 +73,4 @@ Medplum is a healthcare platform that helps you quickly develop high-quality com
|
|
|
79
73
|
|
|
80
74
|
## License
|
|
81
75
|
|
|
82
|
-
Apache 2.0.
|
|
76
|
+
[Apache 2.0](../../LICENSE.txt)
|