From 97051d289568f25deaec601c5a083cb66cd682ff Mon Sep 17 00:00:00 2001 From: kckeim Date: Thu, 16 Nov 2023 15:45:16 -0600 Subject: [PATCH 1/4] Updated MedicationStatement DSTU2 Resource - Updated Overview. Reworded and re-spaced. - Uppercasing and punctuation added in a lot of places. Some spacing changes too (e.g. leading spaces) - Validated and/or fixed all existing links. There were quite a few in this one. - Added "info_link" to many lines in the yaml files - Added link over to MedicationOrder in the relevant section - Consolidated disclaimer + errors & outcomes notice - Updated Custom Extensions for clarity - Updated Parameter Table + Implementation Notes to match current standards - Modified Implementation Notes related to Create and Update sections - Removed unnecessary details - Took field-specific details and moved them to the yaml file(s) so they would appear alongside the relevant field-specific data - Added the standard disclaimer for "only mentioned fields are supported" - Added anonymized opc-request-id and x-request-id to the Create and Update response headers --- .../dstu2/medications/medication-statement.md | 157 ++++++++---------- lib/resources/dstu2/contained_medication.yaml | 10 +- lib/resources/dstu2/medication_statement.yaml | 48 ++++-- ...tion_statement_contained_practitioner.yaml | 3 +- 4 files changed, 103 insertions(+), 115 deletions(-) diff --git a/content/millennium/dstu2/medications/medication-statement.md b/content/millennium/dstu2/medications/medication-statement.md index 848a0a764..89ce02e81 100644 --- a/content/millennium/dstu2/medications/medication-statement.md +++ b/content/millennium/dstu2/medications/medication-statement.md @@ -9,38 +9,44 @@ title: MedicationStatement | DSTU 2 API ## Overview -The Medication Statement resource provides a snapshot in time of known medications taken by the patient now or in the past reported by either the patient, significant other or a provider. Future orders are not returned. Documented historical/past/home medications are commonly captured when taking the patient's medical history. Prescriptions without documented compliance are Intended, since we may not know if the patient is actively taking the medication or has filled the prescription. Medications are assumed to be Taken unless documented otherwise. +The MedicationStatement resource provides a snapshot in time of known medications taken by the patient now, or in the past, and reported by either the patient, a significant other, or a provider. Future orders are not returned. -References to implicitRules and modifierExtensions are NOT supported and will fail a Create or Update request. +Documented historical/past/home medications are commonly captured when taking the patient's medical history. Prescriptions without documented compliance are intended, since we may not know if the patient is actively taking the medication or has filled the prescription. Medications are assumed to be taken unless documented otherwise. The following fields are returned if valued: -* [Id](http://hl7.org/fhir/dstu2/resource-definitions.html#Resource.id){:target="_blank"} -* [Patient](http://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.patient){:target="_blank"} -* [Source of information](http://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.informationSource){:target="_blank"} -* [Date/Time recorded](http://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.dateAsserted){:target="_blank"} -* [Status](http://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.status){:target="_blank"} -* [Was or Was Not Taken](http://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.wasNotTaken){:target="_blank"} -* [Date/Time started and ended](http://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.effective_x_){:target="_blank"} -* [Medication](http://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.medication_x_){:target="_blank"} -* [Reference to source MedicationOrder, if applicable](http://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.supportingInformation){:target="_blank"} +* [Medication Statement ID](https://hl7.org/fhir/dstu2/resource-definitions.html#Resource.id){:target="_blank"} +* [Patient](https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.patient){:target="_blank"} +* [Source of information](https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.informationSource){:target="_blank"} +* [Date/Time recorded](https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.dateAsserted){:target="_blank"} +* [Status](https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.status){:target="_blank"} +* [Was or Was Not Taken](https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.wasNotTaken){:target="_blank"} +* [Date/Time started and ended](https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.effective_x_){:target="_blank"} +* [Medication](https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.medication_x_){:target="_blank"} +* [Reference to source MedicationOrder, if applicable](https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.supportingInformation){:target="_blank"} * [Category Extension](#extensions) * Details of medication taken: - * [Dosage](http://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.dosage){:target="_blank"} - * [Route](http://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.dosage.route){:target="_blank"} - * [Frequency](http://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.dosage.timing){:target="_blank"} - * [Quantity](http://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.dosage.quantity_x_){:target="_blank"} - * [Reason for use](http://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.reasonForUse_x_){:target="_blank"} - * [Site](http://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.dosage.site_x_){:target="_blank"} - * [Rate](http://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.dosage.rate_x_){:target="_blank"} - * [Order comments/special instructions](http://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.note){:target="_blank"} + * [Dosage](https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.dosage){:target="_blank"} + * [Route](https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.dosage.route){:target="_blank"} + * [Frequency](https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.dosage.timing){:target="_blank"} + * [Quantity](https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.dosage.quantity_x_){:target="_blank"} + * [Reason for use](https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.reasonForUse_x_){:target="_blank"} + * [Site](https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.dosage.site_x_){:target="_blank"} + * [Rate](https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.dosage.rate_x_){:target="_blank"} + * [Order comments/special instructions](https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.note){:target="_blank"} * [Patient friendly display Extension](#extensions) ### Querying for Active Medications -To get all possible current medications, an application should query `MedicationStatement` with the `status` query parameter set to `active,intended`. Since `MedicationStatement` is a snapshot in time, this is only a representation of what the system knew of during the last contact with the patient, and will not include things that have happened since the patient last visited with their provider. +To get all possible current medications, an application should query MedicationStatement with the `status` query parameter set to `active,intended`. Since MedicationStatement is a snapshot in time, this is only a representation of what the system knew of during the last contact with the patient, and will not include things that have happened since the patient last visited with their provider. -To get the list of current medications that would likely be shown by default to a practitioner, the `MedicationOrder` resource should be used in addition to the query above in order to ensure that `draft` orders are included. Duplicates can be removed using the `MedicationStatement.supportingInformation` reference. A duplicate is identified when `MedicationOrder.id` is equivalent to the `supportingInformation` referenced `MedicationOrder/[id]` +To get the list of current medications that would likely be shown by default to a practitioner, the [`MedicationOrder`] resource should be used in addition to the query above in order to ensure that `draft` orders are included. Duplicates can be removed using the `MedicationStatement.supportingInformation` reference. A duplicate is identified when `MedicationOrder.id` is equivalent to the `supportingInformation` referenced `MedicationOrder/[id]` + +<%= disclaimer %> + +### Errors + +The common [errors] and [OperationOutcomes] may be returned. ## Terminology Bindings @@ -65,7 +71,7 @@ All URLs for custom extensions are defined as `https://fhir-ehr.cerner.com/dstu2 ID | Value\[x] Type | Description ---------------------------------|---------------------|------------------------------------------------------------------------------------------- - `patient-friendly-display` | [`string`] | The display that can be used for this field when producing a view suitable for a patient. + `patient-friendly-display` | [`string`] | Extension to MedicationRequest.dosageInstruction. The display that can be used for this field when producing a view suitable for a patient. `medication-statement-category` | [`CodeableConcept`] | The [category] of the order, for example: patientspecified, outpatient, etc. @@ -75,11 +81,6 @@ Search for MedicationStatements that meet supplied query parameters: GET /MedicationStatement?:parameters -_Implementation Notes_ - -* [MedicationStatement.informationSource] may be a reference to a [contained] Practitioner or RelatedPerson. Only the relationship between the patient and information source is known, therefore a specific Practitioner or RelatedPerson cannot be referenced. -* [MedicationStatement.medication] may be a reference to a [contained] Medication when the Medication cannot be represented by a CodeableConcept because it contains a unique combination of ingredients. Medications in the system always exist within the context of a MedicationStatement and cannot be be referenced independently. - ### Authorization Types <%= authorization_types(provider: true, patient: true, system: true) %> @@ -88,17 +89,20 @@ _Implementation Notes_ ### Parameters - Name | Required? | Type | Description ------------------|--------------------|---------------|-------------------------------------------------------------------------------------------------------- - `_id` | This, or `patient` | [`token`] | The logical resource id associated with the resource. - `patient` | This, or `_id` | [`reference`] | The identifier of a patient to list statements for. Example: `12345` - `status` | N | [`token`] | The status of the medication statement, may be a list separated by commas. Example: `active,completed` - [`_count`] | N | [`number`] | The maximum number of results to return. Defaults to `50`. + Name | Required? | Type | Description +------------ |---------------|---------------|-------------------------------------------------------------------------------------------------------- + `_id` | Conditionally | [`token`] | The logical resource ID associated with the resource. It may be a list separated by commas. This parameter is required if the `patient` parameter is not used. Example: `_id=1234` + `patient` | Conditionally | [`reference`] | The specific patient to return medication statements for. This parameter is required if the `_id` parameter is not used. Example: `patient=5678` + `status` | No | [`token`] | The status of the medication statement, may be a list separated by commas. Example: `status=active,completed` + [`_count`] | No | [`number`] | The maximum number of results to return. Defaults to `_count=50`. -Notes: +_Implementation Notes_ -* Either the `_id` parameter or a combination of the `patient`, `status`, and `_count` parameters must be provided. +* [MedicationStatement.informationSource] may be a reference to a [contained] Practitioner or RelatedPerson. Only the relationship between the patient and information source is known, therefore a specific Practitioner or RelatedPerson cannot be referenced. +* [MedicationStatement.medication] may be a reference to a [contained] Medication when the Medication cannot be represented by a [`CodeableConcept`] because it contains a unique combination of ingredients. Medications in the system always exist within the context of a MedicationStatement and cannot be be referenced independently. +* When searching with the `_id` parameter: + * It must not be provided with any other parameters. ### Headers @@ -115,23 +119,12 @@ Notes: <%= headers status: 200 %> <%= json(:dstu2_medication_statement_bundle) %> -<%= disclaimer %> - -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - -## Retrieve by id +## Retrieve by ID -List an individual MedicationStatement by its id: +List an individual MedicationStatement by its ID: GET /MedicationStatement/:id -_Implementation Notes_ - -* [MedicationStatement.informationSource] may be a reference to a [contained] Practitioner or RelatedPerson. Only the relationship between the patient and information source is known, therefore a specific Practitioner or RelatedPerson cannot be referenced. -* [MedicationStatement.medication] may be a reference to a [contained] Medication when the Medication cannot be represented by a CodeableConcept because it contains a unique combination of ingredients. Medications in the system always exist within the context of a MedicationStatement and cannot be be referenced independently. - ### Authorization Types <%= authorization_types(provider: true, patient: true, system: true) %> @@ -151,24 +144,17 @@ _Implementation Notes_ <%= headers status: 200 %> <%= json(:dstu2_medication_statement_entry) %> -<%= disclaimer %> - -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - ## Create -Create a new MedicationStatement. +Create a new MedicationStatement: POST /MedicationStatement _Implementation Notes_ -* [MedicationStatement.status] must be set to `active`. -* [MedicationStatement.wasNotTaken] set to `true` is not supported. * If [MedicationStatement.medication] is a reference, it must refer to a [contained] Medication with the code field populated and cannot have any product.ingredients populated. -* Only MedicationStatements about home medications or historical medications can be created. MedicationStatements about prescribed medications cannot be created because MedicationStatement isn't used to capture compliance information. +* Only medication statements about home medications or historical medications can be created. Medication statements about prescribed medications cannot be created because MedicationStatement isn't used to capture compliance information. +* Only the body fields mentioned below are supported. Unsupported fields will be ignored or result in errors. ### Authorization Types @@ -216,30 +202,27 @@ etag: W/"0" location: https://fhir-ehr-code.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/MedicationStatement/20465903 strict-transport-security: max-age=631152000 vary: Origin,User-Agent,Accept-Encoding +opc-request-id: /11111111111111111111111111111111/11111111111111111111111111111111 x-content-type-options: nosniff x-frame-options: SAMEORIGIN -x-request-id: 682c633c-b20f-4f6f-8fae-c58b3aeffe04 +x-request-id: 11111111-1111-1111-1111-111111111111 x-xss-protection: 1; mode=block The `ETag` response header indicates the current `If-Match` version to use on subsequent updates. -<%= disclaimer %> - -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - ## Update -Update a MedicationStatement. +Update a MedicationStatement: PUT /MedicationStatement/:id _Implementation Notes_ -* The only supported change is to update the [MedicationStatement.status] to `completed`. -* Only MedicationStatements that have no reference to a MedicationOrder can be updated. When a MedicationStatement is tied to a prescription or order, its status is updated when the order itself is completed or cancelled. +* Only medication statements without a reference to a Medication order can be updated. When a medication statement is tied to a prescription or order, its status is updated when the order itself is completed or cancelled. +* Only the body fields mentioned below are supported. Unsupported fields will be ignored or result in errors. +* In addition to the common [errors], the following error may be returned: + * Updating a medication statement without sending the `If-Match` header will result in a `412 Precondition Failed` response. ### Authorization Types @@ -283,38 +266,28 @@ cache-control: no-cache etag: W/"1" strict-transport-security: max-age=631152000 vary: Origin,User-Agent,Accept-Encoding +opc-request-id: /11111111111111111111111111111111/11111111111111111111111111111111 x-content-type-options: nosniff x-frame-options: SAMEORIGIN -x-request-id: 9dba8326-899a-406f-a125-3fc3d6605dad +x-request-id: 11111111-1111-1111-1111-111111111111 x-xss-protection: 1; mode=block The `ETag` response header indicates the current `If-Match` version to use on subsequent updates. -<%= disclaimer %> - -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - -In addition, the following error may be returned: - -* Updating a MedicationStatement without sending the `If-Match` header will result in a `412 Precondition Failed` response. - -[`reference`]: http://hl7.org/fhir/DSTU2/search.html#reference -[`token`]: http://hl7.org/fhir/DSTU2/search.html#token -[`date`]: http://hl7.org/fhir/DSTU2/search.html#date -[`_count`]: http://hl7.org/fhir/DSTU2/search.html#count -[`number`]: http://hl7.org/fhir/DSTU2/search.html#number -[`string`]: http://hl7.org/fhir/DSTU2/datatypes.html#string -[`CodeableConcept`]: http://hl7.org/fhir/DSTU2/datatypes.html#codeableconcept -[contained]: http://hl7.org/fhir/DSTU2/references.html#contained -[MedicationStatement.informationSource]: http://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.informationSource -[MedicationStatement.medication]: http://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.medication_x_ -[MedicationStatement.status]: http://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.status -[MedicationStatement.wasNotTaken]: http://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.wasNotTaken +[`reference`]: https://hl7.org/fhir/DSTU2/search.html#reference +[`token`]: https://hl7.org/fhir/DSTU2/search.html#token +[`date`]: https://hl7.org/fhir/DSTU2/search.html#date +[`_count`]: https://hl7.org/fhir/DSTU2/search.html#count +[`number`]: https://hl7.org/fhir/DSTU2/search.html#number +[`string`]: https://hl7.org/fhir/DSTU2/datatypes.html#string +[`CodeableConcept`]: https://hl7.org/fhir/DSTU2/datatypes.html#codeableconcept +[contained]: https://hl7.org/fhir/DSTU2/references.html#contained +[MedicationStatement.informationSource]: https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.informationSource +[MedicationStatement.medication]: https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.medication_x_ [errors]: ../../#client-errors [OperationOutcomes]: ../../#operation-outcomes [Patient friendly display]: #custom-extensions [Order category]: #custom-extensions -[category]: http://hl7.org/fhir/stu3/valueset-medication-statement-category.html +[category]: https://hl7.org/fhir/stu3/valueset-medication-statement-category.html +[`MedicationOrder`]: ../medication-order/#overview diff --git a/lib/resources/dstu2/contained_medication.yaml b/lib/resources/dstu2/contained_medication.yaml index bcd274b53..a4359c8e6 100644 --- a/lib/resources/dstu2/contained_medication.yaml +++ b/lib/resources/dstu2/contained_medication.yaml @@ -1,12 +1,12 @@ --- name: Medication -field_name_base_url: http://hl7.org/fhir/DSTU2/medication-definitions.html#Medication +field_name_base_url: https://hl7.org/fhir/DSTU2/medication-definitions.html#Medication fields: - name: code required: 'No' type: CodeableConcept - description: Codes that identify this medication. + description: Codes that identify this medication. example: | { "code": { @@ -25,8 +25,8 @@ fields: description: A code that defines the type of medication. terminology: - display: RxNorm - system: http://www.nlm.nih.gov/research/umls/rxnorm - info_link: http://hl7.org/fhir/dstu2/rxnorm.html + system: https://www.nlm.nih.gov/research/umls/rxnorm + info_link: https://hl7.org/fhir/dstu2/rxnorm.html - name: product required: 'No' @@ -43,4 +43,4 @@ fields: terminology: - display: NCI Metathesaurus system: http://ncimeta.nci.nih.gov - info_link: http://hl7.org/fhir/dstu2/ncimeta.html + info_link: https://hl7.org/fhir/dstu2/ncimeta.html diff --git a/lib/resources/dstu2/medication_statement.yaml b/lib/resources/dstu2/medication_statement.yaml index 64dde5a91..05ab3f5d8 100644 --- a/lib/resources/dstu2/medication_statement.yaml +++ b/lib/resources/dstu2/medication_statement.yaml @@ -1,6 +1,6 @@ --- name: MedicationStatement -field_name_base_url: http://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement +field_name_base_url: https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement fields: - name: resourceType required: 'Yes' @@ -10,18 +10,18 @@ fields: { "resourceType: "MedicationStatement" } - note: resourceType must be MedicationStatement - url: http://hl7.org/fhir/DSTU2/json.html#resources + note: resourceType must be MedicationStatement. + url: https://hl7.org/fhir/DSTU2/json.html#resources - name: id required: 'Yes' type: id - description: The logical id of the resource to update. + description: The logical ID of the resource to update. example: | { "id": "123412" } - url: http://hl7.org/fhir/DSTU2/resource-definitions.html#Resource.id + url: https://hl7.org/fhir/DSTU2/resource-definitions.html#Resource.id action: update - name: patient @@ -39,33 +39,41 @@ fields: required: 'Yes' type: code description: > - A code representing the patient or other source's judgment about the state of the medication used that this + A code representing the patient or other source's judgment about the state of the medication that this statement is about. example: | { "status": "active" } + note: | + - name: reasonForUse[x] required: 'No' type: CodeableConcept action: search - url: http://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.reasonForUse_x_ + url: https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.reasonForUse_x_ binding: description: A reason for why the medication is being/was taken. terminology: - display: SNOMED CT system: http://snomed.info/sct + info_link: https://hl7.org/fhir/dstu2/snomedct.html - display: ICD-9 system: http://hl7.org/fhir/sid/icd-9 + info_link: https://terminology.hl7.org/ICD.html#icd-9-variants - display: ICD-10 system: http://hl7.org/fhir/sid/icd-10 + info_link: https://terminology.hl7.org/CodeSystem-icd10CM.html - name: effectivePeriod required: 'No' type: Period description: The interval of time during which it is being asserted that the patient was taking the medication. - note: If effectivePeriod and dosage.timing.repeat.boundsPeriod are both populated they need to be the same value. + note: If effectivePeriod and dosage.timing.repeat.boundsPeriod are both populated, they must be the same value. example: | { "effectivePeriod": { @@ -73,7 +81,7 @@ fields: "end": "2015-05-06T01:00:00.000Z" } } - url: http://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.effective_x_ + url: https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.effective_x_ action: create - name: note @@ -113,12 +121,13 @@ fields: "text": "ciprofloxacin" } } - url: http://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.medication_x_ + url: https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.medication_x_ binding: description: A code that defines the type of medication. terminology: - display: RxNorm system: http://www.nlm.nih.gov/research/umls/rxnorm + info_link: https://hl7.org/fhir/dstu2/rxnorm.html - name: dosage required: 'No' @@ -147,7 +156,7 @@ fields: required: 'No' type: Element description: A set of rules that describe when the event should occur. - url: http://hl7.org/fhir/DSTU2/datatypes-definitions.html#Timing.repeat + url: https://hl7.org/fhir/DSTU2/datatypes-definitions.html#Timing.repeat children: - name: bounds[x] @@ -155,6 +164,7 @@ fields: type: Period | Duration description: > Either the length of timing schedule or the outer bounds for start and/or end limits of the timing schedule. + note: If effectivePeriod and dosage.timing.repeat.boundsPeriod are both populated, they must be the same value. example: | { "boundsPeriod": { @@ -172,7 +182,7 @@ fields: } } - url: http://hl7.org/fhir/DSTU2/datatypes-definitions.html#Timing.repeat.bounds_x_ + url: https://hl7.org/fhir/DSTU2/datatypes-definitions.html#Timing.repeat.bounds_x_ - name: count required: 'No' @@ -182,7 +192,7 @@ fields: { "count": 5 } - url: http://hl7.org/fhir/DSTU2/datatypes-definitions.html#Timing.repeat.count + url: https://hl7.org/fhir/DSTU2/datatypes-definitions.html#Timing.repeat.count - name: code required: 'No' @@ -201,14 +211,16 @@ fields: "text": "TID" } } - url: http://hl7.org/fhir/DSTU2/datatypes-definitions.html#Timing.code + url: https://hl7.org/fhir/DSTU2/datatypes-definitions.html#Timing.code binding: description: Code for a known / defined timing pattern. terminology: - display: TimingAbbreviation system: http://hl7.org/fhir/timing-abbreviation + info_link: https://hl7.org/fhir/dstu2/valueset-timing-abbreviation.html - display: SNOMED CT system: http://snomed.info/sct + info_link: https://hl7.org/fhir/dstu2/snomedct.html - name: asNeeded[x] required: 'No' @@ -238,7 +250,8 @@ fields: terminology: - display: SNOMED CT system: http://snomed.info/sct - url: http://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.dosage.asNeeded_x_ + info_link: https://hl7.org/fhir/dstu2/snomedct.html + url: https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.dosage.asNeeded_x_ - name: siteCodeableConcept required: 'No' @@ -262,7 +275,8 @@ fields: terminology: - display: SNOMED CT system: http://snomed.info/sct - url: http://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.dosage.site_x_ + info_link: https://hl7.org/fhir/dstu2/snomedct.html + url: https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.dosage.site_x_ - name: route required: 'No' @@ -307,4 +321,4 @@ fields: "code": "tbl" } } - url: http://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.dosage.quantity_x_ + url: https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.dosage.quantity_x_ diff --git a/lib/resources/dstu2/medication_statement_contained_practitioner.yaml b/lib/resources/dstu2/medication_statement_contained_practitioner.yaml index 884e662da..08fea29fd 100644 --- a/lib/resources/dstu2/medication_statement_contained_practitioner.yaml +++ b/lib/resources/dstu2/medication_statement_contained_practitioner.yaml @@ -1,6 +1,6 @@ --- name: Practitioner -field_name_base_url: http://hl7.org/fhir/DSTU2/practitioner-definitions.html#Practitioner +field_name_base_url: https://hl7.org/fhir/DSTU2/practitioner-definitions.html#Practitioner fields: - name: practitionerRole @@ -18,3 +18,4 @@ fields: terminology: - display: Practitioner Role system: http://hl7.org/fhir/practitioner-role + info_link: https://hl7.org/fhir/DSTU2/practitioner-definitions.html#Practitioner.practitionerRole.role From c75175c73c91c7d22f03c85cb5b8a300d238ea7e Mon Sep 17 00:00:00 2001 From: "Deitrich, Casey" Date: Tue, 21 Nov 2023 15:34:27 -0600 Subject: [PATCH 2/4] PRODOC-203652: Style edits. --- .../dstu2/medications/medication-statement.md | 44 +++++++++---------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/content/millennium/dstu2/medications/medication-statement.md b/content/millennium/dstu2/medications/medication-statement.md index 89ce02e81..e149b3e04 100644 --- a/content/millennium/dstu2/medications/medication-statement.md +++ b/content/millennium/dstu2/medications/medication-statement.md @@ -9,9 +9,9 @@ title: MedicationStatement | DSTU 2 API ## Overview -The MedicationStatement resource provides a snapshot in time of known medications taken by the patient now, or in the past, and reported by either the patient, a significant other, or a provider. Future orders are not returned. +The MedicationStatement resource provides a snapshot in time of known medications taken by the patient now or in the past, which were reported by the patient, a significant other, or a provider. Future orders are not returned. -Documented historical/past/home medications are commonly captured when taking the patient's medical history. Prescriptions without documented compliance are intended, since we may not know if the patient is actively taking the medication or has filled the prescription. Medications are assumed to be taken unless documented otherwise. +Historical, past, or home medications are commonly captured when documenting the patient's medical history. Prescriptions without documented compliance are considered intended because whether the patient is actively taking the medication or has filled the prescription is unknown. Medications are assumed to be taken unless documented otherwise. The following fields are returned if valued: @@ -38,9 +38,9 @@ The following fields are returned if valued: ### Querying for Active Medications -To get all possible current medications, an application should query MedicationStatement with the `status` query parameter set to `active,intended`. Since MedicationStatement is a snapshot in time, this is only a representation of what the system knew of during the last contact with the patient, and will not include things that have happened since the patient last visited with their provider. +To get all possible current medications, an application should query the MedicationStatement resource with the `status` query parameter set to `active,intended`. Because the MedicationStatement resource provides a snapshot in time, the reponse includes only the information that was in the system as of the last contact with the patient. Changes in medications that occurred after the patient last visited their provider are not included. -To get the list of current medications that would likely be shown by default to a practitioner, the [`MedicationOrder`] resource should be used in addition to the query above in order to ensure that `draft` orders are included. Duplicates can be removed using the `MedicationStatement.supportingInformation` reference. A duplicate is identified when `MedicationOrder.id` is equivalent to the `supportingInformation` referenced `MedicationOrder/[id]` +To get the list of current medications that would likely be shown by default to a practitioner, use the [MedicationOrder] resource and the query above to ensure that `draft` orders are included. You can use the `MedicationStatement.supportingInformation` reference to remove duplicates. A duplicate is identified when the `MedicationOrder.id` is equivalent to the `MedicationOrder/[id]` in the `supportingInformation` reference. <%= disclaimer %> @@ -71,13 +71,13 @@ All URLs for custom extensions are defined as `https://fhir-ehr.cerner.com/dstu2 ID | Value\[x] Type | Description ---------------------------------|---------------------|------------------------------------------------------------------------------------------- - `patient-friendly-display` | [`string`] | Extension to MedicationRequest.dosageInstruction. The display that can be used for this field when producing a view suitable for a patient. - `medication-statement-category` | [`CodeableConcept`] | The [category] of the order, for example: patientspecified, outpatient, etc. + `patient-friendly-display` | [`string`] | Extension to MedicationRequest.dosageInstruction. The display name that can be used for this field when producing a view suitable for a patient. + `medication-statement-category` | [`CodeableConcept`] | The [category] of the order, for example: patientspecified, outpatient, and so on. ## Search -Search for MedicationStatements that meet supplied query parameters: +Search for medication statements that meet supplied query parameters. GET /MedicationStatement?:parameters @@ -93,14 +93,14 @@ Search for MedicationStatements that meet supplied query parameters: ------------ |---------------|---------------|-------------------------------------------------------------------------------------------------------- `_id` | Conditionally | [`token`] | The logical resource ID associated with the resource. It may be a list separated by commas. This parameter is required if the `patient` parameter is not used. Example: `_id=1234` `patient` | Conditionally | [`reference`] | The specific patient to return medication statements for. This parameter is required if the `_id` parameter is not used. Example: `patient=5678` - `status` | No | [`token`] | The status of the medication statement, may be a list separated by commas. Example: `status=active,completed` + `status` | No | [`token`] | The status of the medication statement. It may be a list separated by commas. Example: `status=active,completed` [`_count`] | No | [`number`] | The maximum number of results to return. Defaults to `_count=50`. -_Implementation Notes_ +_Notes_ -* [MedicationStatement.informationSource] may be a reference to a [contained] Practitioner or RelatedPerson. Only the relationship between the patient and information source is known, therefore a specific Practitioner or RelatedPerson cannot be referenced. -* [MedicationStatement.medication] may be a reference to a [contained] Medication when the Medication cannot be represented by a [`CodeableConcept`] because it contains a unique combination of ingredients. Medications in the system always exist within the context of a MedicationStatement and cannot be be referenced independently. +* [MedicationStatement.informationSource] may be a reference to a [contained] practitioner or related person. Only the relationship between the patient and information source is known; therefore, a specific practitioner or related person cannot be referenced. +* [MedicationStatement.medication] may be a reference to a [contained] medication when the medication cannot be represented by a [`CodeableConcept`] because it contains a unique combination of ingredients. Medications in the system always exist in the context of a medication statement and cannot be be referenced independently. * When searching with the `_id` parameter: * It must not be provided with any other parameters. @@ -121,7 +121,7 @@ _Implementation Notes_ ## Retrieve by ID -List an individual MedicationStatement by its ID: +List an individual medication statement by its ID. GET /MedicationStatement/:id @@ -146,15 +146,15 @@ List an individual MedicationStatement by its ID: ## Create -Create a new MedicationStatement: +Create a new medication statement. POST /MedicationStatement -_Implementation Notes_ +_Notes_ -* If [MedicationStatement.medication] is a reference, it must refer to a [contained] Medication with the code field populated and cannot have any product.ingredients populated. -* Only medication statements about home medications or historical medications can be created. Medication statements about prescribed medications cannot be created because MedicationStatement isn't used to capture compliance information. -* Only the body fields mentioned below are supported. Unsupported fields will be ignored or result in errors. +* If [MedicationStatement.medication] is a reference, it must refer to a [contained] medication with the code field populated and cannot have any product.ingredients populated. +* Only medication statements about home medications or historical medications can be created. Medication statements about prescribed medications cannot be created because the MedicationStatement resource is not used to capture compliance information. +* Only the body fields mentioned below are supported. Unsupported fields are ignored or result in errors. ### Authorization Types @@ -213,16 +213,16 @@ The `ETag` response header indicates the current `If-Match` version to use on su ## Update -Update a MedicationStatement: +Update a medication statement. PUT /MedicationStatement/:id -_Implementation Notes_ +_Notes_ -* Only medication statements without a reference to a Medication order can be updated. When a medication statement is tied to a prescription or order, its status is updated when the order itself is completed or cancelled. -* Only the body fields mentioned below are supported. Unsupported fields will be ignored or result in errors. +* Only medication statements without a reference to a medication order can be updated. When a medication statement is associated with a prescription or order, its status is updated when the order itself is completed or canceled. +* Only the body fields mentioned below are supported. Unsupported fields are ignored or result in errors. * In addition to the common [errors], the following error may be returned: - * Updating a medication statement without sending the `If-Match` header will result in a `412 Precondition Failed` response. + * Updating a medication statement without sending the `If-Match` header returns a `412 Precondition Failed` response. ### Authorization Types From 39bb979a63a0a9005ea1d660524e03e7f32587fb Mon Sep 17 00:00:00 2001 From: kckeim Date: Tue, 28 Nov 2023 10:26:24 -0600 Subject: [PATCH 3/4] Uppercasing for referenced resource names --- .../millennium/dstu2/medications/medication-statement.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/millennium/dstu2/medications/medication-statement.md b/content/millennium/dstu2/medications/medication-statement.md index e149b3e04..ff929ac4e 100644 --- a/content/millennium/dstu2/medications/medication-statement.md +++ b/content/millennium/dstu2/medications/medication-statement.md @@ -99,8 +99,8 @@ Search for medication statements that meet supplied query parameters. _Notes_ -* [MedicationStatement.informationSource] may be a reference to a [contained] practitioner or related person. Only the relationship between the patient and information source is known; therefore, a specific practitioner or related person cannot be referenced. -* [MedicationStatement.medication] may be a reference to a [contained] medication when the medication cannot be represented by a [`CodeableConcept`] because it contains a unique combination of ingredients. Medications in the system always exist in the context of a medication statement and cannot be be referenced independently. +* [MedicationStatement.informationSource] may be a reference to a [contained] Practitioner or RelatedPerson. Only the relationship between the patient and information source is known; therefore, a specific practitioner or related person cannot be referenced. +* [MedicationStatement.medication] may be a reference to a [contained] Medication when the medication cannot be represented by a [`CodeableConcept`] because it contains a unique combination of ingredients. Medications in the system always exist in the context of a medication statement and cannot be be referenced independently. * When searching with the `_id` parameter: * It must not be provided with any other parameters. @@ -152,7 +152,7 @@ Create a new medication statement. _Notes_ -* If [MedicationStatement.medication] is a reference, it must refer to a [contained] medication with the code field populated and cannot have any product.ingredients populated. +* If [MedicationStatement.medication] is a reference, it must refer to a [contained] Medication with the code field populated and cannot have any product.ingredients populated. * Only medication statements about home medications or historical medications can be created. Medication statements about prescribed medications cannot be created because the MedicationStatement resource is not used to capture compliance information. * Only the body fields mentioned below are supported. Unsupported fields are ignored or result in errors. From f18fcce34f399cc8d18c82b6cb58bf65b4b7f6c5 Mon Sep 17 00:00:00 2001 From: Aaron McGinn Date: Thu, 14 Dec 2023 13:34:32 -0600 Subject: [PATCH 4/4] Update lib/resources/dstu2/contained_medication.yaml --- lib/resources/dstu2/contained_medication.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/resources/dstu2/contained_medication.yaml b/lib/resources/dstu2/contained_medication.yaml index a4359c8e6..5b150f0e1 100644 --- a/lib/resources/dstu2/contained_medication.yaml +++ b/lib/resources/dstu2/contained_medication.yaml @@ -25,7 +25,7 @@ fields: description: A code that defines the type of medication. terminology: - display: RxNorm - system: https://www.nlm.nih.gov/research/umls/rxnorm + system: http://www.nlm.nih.gov/research/umls/rxnorm info_link: https://hl7.org/fhir/dstu2/rxnorm.html - name: product