Skip to content

Commit

Permalink
NIAD-3220: Documentation Update
Browse files Browse the repository at this point in the history
Update README.md for `ReferralRequest`.
Update README.md for `Condition`.
  • Loading branch information
MartinWheelerMT committed Nov 20, 2024
1 parent 1e3d597 commit d40b0a3
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 2 deletions.
9 changes: 8 additions & 1 deletion conditions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,14 @@

A FHIR Condition is mapped from a LinkSet, a LinkSet references different resources that are mapped from an Observation statement and an EHR Composition.

The LinkSet will gather the codes/values/naming conventions from the Ehr Composition. Therefore, the LinkSet will then map out the fields below if certain conditions are met, otherwise it will add in a default value.
The LinkSet will gather the codes/values/naming conventions from the Ehr Composition. Therefore, the LinkSet will then map out the fields below if certain conditions are met, otherwise it will add in a default value.

If the LinkSet fulfills the following requirements (which is a linkage between a ReferralRequest and one or more DocumentReferences),
then the LinkSet will not be mapped:
- It has a `code` with a `value` of `394776006` and a `system` of `2.16.840.1.113883.2.1.3.2.4.15` and no `qualifier` and no `originalText`
- The `conditionNamed / namedStatementRef / id[root]` is a `RequestStatement`
- It has at least 1 `component`
- All the `component / statementRef / id[root]` are references to GP2GP document/attachments.

| Mapped to (JSON FHIR Condition field) | Mapped from (XML HL7 / other source) |
|---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
Expand Down
12 changes: 11 additions & 1 deletion referral requests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,18 @@ A Referral Request is mapped from a `RequestStatement`
| recipient | reference to mapped [Practitioner](../practitioners/README.md) or [Organization](../organizations/README.md) from `RequestStatement / responsibleParty / agentRef` |
| reasonCode | mapped CodeableConcept from `RequestStatement / code` <sup>1</sup> as described in the XML > FHIR section of [Codeable Concept](../codeable%20concept/README.md) |
| note | mapped Annotation from `RequestStatement / text` & `RequestStatement / priorityCode` & `RequestStatement / priorityCode` |
| supportingInfo | one or more `DocumentReferences` mapped a `LinkSet / component / statementRef / id [@root]` where `LinkSet / conditionNamed / namedStatementRef / id [@root]` references `RequestStatement / id [@root]`<sup>2</sup> |

1. If the SNOMED code is not found then a `Transfer-degraded referral` code is inserted instead (96431000000106)
2. Only populated when the `RequestStatement` is referenced by a `LinkSet` which is a linkage between a
`ReferralRequest` and one or more `DocumentReferences`.

The following Allergy Intolerance fields are not currently populated by the adaptor:
- basedOn
- serviceRequested
- requester.onBehalfOf
- speciality
- description
- supportingInfo


<details>
Expand Down Expand Up @@ -93,6 +95,14 @@ The following Allergy Intolerance fields are not currently populated by the adap
"text": "Reason Code 1"
}
],
"supportingInfo": [
{
"reference": "DocumentReference/BFBF038A-F142-4C67-B05B-D155E2C89990"
},
{
"reference": "DocumentReference/6DC83A17-4DFD-4C1C-A452-45F8F8A8FBA1"
}
],
"note": [
{
"text": "Priority: Routine"
Expand Down

0 comments on commit d40b0a3

Please sign in to comment.