-
Notifications
You must be signed in to change notification settings - Fork 16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add clinical documentation use case #47
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…with leading underscore name change to internal funcs
…in cda request/response models
adamkells
approved these changes
Jul 22, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #26 and fixes #24
This PR adds
ClinicalDocumentation
use case to the library. Changes include:BaseClient
class to ensure a uniform API for use cases (fixes Function tagged as API can't be called 'Service' #24 by having default attributes have leading underscore).ClinicalDocumentation
use case and strategy inuse_case/
(process_notereader_document()
mounted to/notereader
path)cda_parser/
module. TheCdaAnnotator
is responsible for parsing, loading, and annotating a CCD (Continuity of Care Document) data from CDA files required for theClinicalDocumentation
use case. Internally, it uses thexmltodict
library to represent an XML object as a JSON-compatible dictionary. Dictionary representations of CDA data structures are then validated as Pydantic models incda_parser/model/
(Additional data structures may be needed for medications and allergies - they are currently being parsed as a plain dict to preserve data, but will need some validation). I have only implemented functionality for the problems list in this PR. User facing API includes:.add_to_problem_list()
: Adds a list ofProblemConcept
to the CDA document..add_to_medication_list(): Adds a list of
MedicationConcept` to the CDA document - will raise NotImplementedError..add_to_medication_list(): Adds a list of
AllergyConcept` to the CDA document - will raise NotImplementedError..export()
: Exports the CDA document as a string. Option to pretty print or overwrite existing entries..send_request()
method ofEHRClient
.sandbox
.CcdData
as a system-agnostic model container for CCD data (contains problems, allergies, medications concept lists, note, and optional raw CDA XML string).Concept
as a system-agnostic model container for coded concepts.CdaRequest
andCdaResponse
models for use case.api_protocol
attribute to the data modelEndpoint
.service/soap
(implemented withspyne
)@adamkells It would be good for you to implement the medications and allergies methods
CcdAnnotator
to get a bit of familiarity with CDA 😺Also to do is synthetic data generator methods for CDA. Currently you can load an existing CDA file and use that for testing. We need to complete the implementation for medications and allergies sections first.
I wouldn't mind optimising the
pyproject.toml
so that users can just download whichever use case they need so they don't need all this xml stuff if they're not using the clindoc use case...but that's for another PR.