From 86612139b6d7043b96cbabb2e7252d14a8fe991a Mon Sep 17 00:00:00 2001 From: kckeim Date: Wed, 18 Oct 2023 14:13:13 -0500 Subject: [PATCH 1/8] Updated Immunization R4 Resource - Re-did Overview paragraph. - Matches what HL7.org has, and is in-line with the recent proposed DSTU2 formatting. - Now includes direct links out to the `AllergyIntolerance` and `MedicationAdministration` resources. - Switched links from http -> https for HL7.org in markdown and yaml files - Modified link structure around the `Note` field, and referenced over to the `Annotation` formatting for R4. - Switched to single dislaimer + errors/outcomes notice - Many updates to Parameter table and Implementation Notes, to match the performance of the API, and explain requirements and expected behavior of each search parameter. - Anonymized the X-Request ID's for the Create / Update sections --- .../r4/clinical/medications/immunization.md | 142 ++++++++---------- lib/resources/r4/immunization.yaml | 26 ++-- 2 files changed, 79 insertions(+), 89 deletions(-) diff --git a/content/millennium/r4/clinical/medications/immunization.md b/content/millennium/r4/clinical/medications/immunization.md index 566e64f74..3d3a418e0 100644 --- a/content/millennium/r4/clinical/medications/immunization.md +++ b/content/millennium/r4/clinical/medications/immunization.md @@ -9,11 +9,11 @@ title: Immunization | R4 API ## Overview -The Immunization resource includes the view of current and historical administration of vaccinations to a patient in all healthcare settings. This resource contains the functionality to query a patient's immunization history. +The Immunization resource is intended to cover the recording of current and historical administration of vaccines to patients across all healthcare disciplines in all care settings and all regions. This resource contains the functionality to query a patient's immunization history. Detailed administration records may be found in the [`MedicationAdministration`] resource, while this Immunization resource would represent the known vaccination history regardless of where the administration itself was done. -Detailed administration records may be found in MedicationAdministration, while the Immunization resource would represent the known vaccination history regardless of where the administration itself was done. +An immunization reaction may indicate an allergy or intolerance. If so, a separate [`AllergyIntolerance`] resource instance should be created as well. -An immunization reaction may indicate an allergy or intolerance. If so, a separate AllergyIntolerance resource instance should be created as well. +Note that while the terms "immunization" and "vaccination" are not clinically identical, for the purposes of FHIR resources, the terms are used synonymously. * The following [HL7® FHIR® US Core Implementation Guide STU 4.0.0](https://hl7.org/fhir/us/core/STU4/) Profiles are supported by this resource: @@ -21,35 +21,40 @@ An immunization reaction may indicate an allergy or intolerance. If so, a separa The following fields are returned if valued: -* [Id](http://hl7.org/fhir/R4/resource-definitions.html#Resource.id){:target="_blank"} +* [Id](https://hl7.org/fhir/R4/resource-definitions.html#Resource.id){:target="_blank"} * [Immunization Record Identifier](https://hl7.org/fhir/R4/immunization-definitions.html#Immunization.identifier){:target="_blank"} -* [Status](http://hl7.org/fhir/R4/immunization-definitions.html#Immunization.status){:target="_blank"} -* [Status reason](http://hl7.org/fhir/R4/immunization-definitions.html#Immunization.statusReason){:target="_blank"} -* [Vaccine administered](http://hl7.org/fhir/R4/immunization-definitions.html#Immunization.vaccineCode){:target="_blank"} -* [Patient](http://hl7.org/fhir/R4/immunization-definitions.html#Immunization.patient){:target="_blank"} -* [Patient encounter](http://hl7.org/fhir/R4/immunization-definitions.html#Immunization.encounter){:target="_blank"} -* [Occurrence DateTime](http://hl7.org/fhir/R4/immunization-definitions.html#Immunization.occurrence_x_){:target="_blank"} -* [Primary Source](http://hl7.org/fhir/R4/immunization-definitions.html#Immunization.primarySource){:target="_blank"} -* [Report Origin](http://hl7.org/fhir/R4/immunization-definitions.html#Immunization.reportOrigin){:target="_blank"} -* [Location](http://hl7.org/fhir/R4/immunization-definitions.html#Immunization.location){:target="_blank"} -* [Vaccine manufacturer](http://hl7.org/fhir/R4/immunization-definitions.html#Immunization.manufacturer){:target="_blank"} -* [Vaccine lot number](http://hl7.org/fhir/R4/immunization-definitions.html#Immunization.lotNumber){:target="_blank"} -* [Vaccine expiration date](http://hl7.org/fhir/R4/immunization-definitions.html#Immunization.expirationDate){:target="_blank"} -* [Vaccine administration site](http://hl7.org/fhir/R4/immunization-definitions.html#Immunization.site){:target="_blank"} -* [Vaccine administration route](http://hl7.org/fhir/R4/immunization-definitions.html#Immunization.route){:target="_blank"} -* [Dosage administered](http://hl7.org/fhir/R4/immunization-definitions.html#Immunization.doseQuantity){:target="_blank"} -* [Performer](http://hl7.org/fhir/R4/immunization-definitions.html#Immunization.performer){:target="_blank"} - * [Type of performer (ordering or administering)](http://hl7.org/fhir/R4/immunization-definitions.html#Immunization.performer.function){:target="_blank"} - * [Individual who performed](http://hl7.org/fhir/R4/immunization-definitions.html#Immunization.performer.actor){:target="_blank"} - * [Reference](http://hl7.org/fhir/r4/references.html#Reference){:target="_blank"} ([Practitioner](https://hl7.org/fhir/r4/practitioner.html){:target="_blank"} \| [Organization](http://hl7.org/fhir/R4/organization.html){:target="_blank"}) -* [Note](http://hl7.org/fhir/R4/immunization-definitions.html#Immunization.note){:target="_blank"} - * [Author reference](http://hl7.org/fhir/R4/immunization-definitions.html#Immunization.note){:target="_blank"} - * [Reference](http://hl7.org/fhir/r4/references.html#Reference){:target="_blank"} ([Practitioner](https://hl7.org/fhir/r4/practitioner.html){:target="_blank"}) - * [Time](http://hl7.org/fhir/R4/datatypes-definitions.html#Annotation.time){:target="_blank"} - * [Text](http://hl7.org/fhir/R4/datatypes-definitions.html#Annotation.text){:target="_blank"} -* [Protocol applied](http://hl7.org/fhir/R4/immunization-definitions.html#Immunization.protocolApplied){:target="_blank"} - * [Dose Number String](http://hl7.org/fhir/R4/immunization-definitions.html#Immunization.protocolApplied.doseNumber_x_){:target="_blank"} - * [Target disease](http://hl7.org/fhir/R4/immunization-definitions.html#Immunization.protocolApplied.targetDisease){:target="_blank"} +* [Status](https://hl7.org/fhir/R4/immunization-definitions.html#Immunization.status){:target="_blank"} +* [Status reason](https://hl7.org/fhir/R4/immunization-definitions.html#Immunization.statusReason){:target="_blank"} +* [Vaccine administered](https://hl7.org/fhir/R4/immunization-definitions.html#Immunization.vaccineCode){:target="_blank"} +* [Patient](https://hl7.org/fhir/R4/immunization-definitions.html#Immunization.patient){:target="_blank"} +* [Patient encounter](https://hl7.org/fhir/R4/immunization-definitions.html#Immunization.encounter){:target="_blank"} +* [Occurrence DateTime](https://hl7.org/fhir/R4/immunization-definitions.html#Immunization.occurrence_x_){:target="_blank"} +* [Primary Source](https://hl7.org/fhir/R4/immunization-definitions.html#Immunization.primarySource){:target="_blank"} +* [Report Origin](https://hl7.org/fhir/R4/immunization-definitions.html#Immunization.reportOrigin){:target="_blank"} +* [Location](https://hl7.org/fhir/R4/immunization-definitions.html#Immunization.location){:target="_blank"} +* [Vaccine manufacturer](https://hl7.org/fhir/R4/immunization-definitions.html#Immunization.manufacturer){:target="_blank"} +* [Vaccine lot number](https://hl7.org/fhir/R4/immunization-definitions.html#Immunization.lotNumber){:target="_blank"} +* [Vaccine expiration date](https://hl7.org/fhir/R4/immunization-definitions.html#Immunization.expirationDate){:target="_blank"} +* [Vaccine administration site](https://hl7.org/fhir/R4/immunization-definitions.html#Immunization.site){:target="_blank"} +* [Vaccine administration route](https://hl7.org/fhir/R4/immunization-definitions.html#Immunization.route){:target="_blank"} +* [Dosage administered](https://hl7.org/fhir/R4/immunization-definitions.html#Immunization.doseQuantity){:target="_blank"} +* [Performer](https://hl7.org/fhir/R4/immunization-definitions.html#Immunization.performer){:target="_blank"} + * [Type of performer (ordering or administering)](https://hl7.org/fhir/R4/immunization-definitions.html#Immunization.performer.function){:target="_blank"} + * [Individual who performed](https://hl7.org/fhir/R4/immunization-definitions.html#Immunization.performer.actor){:target="_blank"} + * [Reference](https://hl7.org/fhir/r4/references.html#Reference){:target="_blank"} ([Practitioner](https://hl7.org/fhir/r4/practitioner.html){:target="_blank"} \| [Organization](https://hl7.org/fhir/R4/organization.html){:target="_blank"}) +* [Note](https://hl7.org/fhir/R4/immunization-definitions.html#Immunization.note){:target="_blank"} (follows [Annotation](https://hl7.org/fhir/R4/datatypes.html#Annotation) structure) + * [Reference](https://hl7.org/fhir/r4/references.html#Reference){:target="_blank"} ([Practitioner](https://hl7.org/fhir/r4/practitioner.html){:target="_blank"}) + * [Time](https://hl7.org/fhir/R4/datatypes-definitions.html#Annotation.time){:target="_blank"} + * [Text](https://hl7.org/fhir/R4/datatypes-definitions.html#Annotation.text){:target="_blank"} +* [Protocol applied](https://hl7.org/fhir/R4/immunization-definitions.html#Immunization.protocolApplied){:target="_blank"} + * [Dose Number String](https://hl7.org/fhir/R4/immunization-definitions.html#Immunization.protocolApplied.doseNumber_x_){:target="_blank"} + * [Target disease](https://hl7.org/fhir/R4/immunization-definitions.html#Immunization.protocolApplied.targetDisease){:target="_blank"} + +<%= disclaimer %> + +### Errors + +The common [errors] and [OperationOutcomes] may be returned. ## Terminology Bindings @@ -69,23 +74,33 @@ Search for Immunizations that meet supplied query parameters: Name | Required? | Type | Description ------------------|--------------------|---------------|----------------------------------------------------------------------------------------------------- - `_id` | This, or `patient` | [`token`] | The logical resource id associated with the resource. + `_id` | This, or `patient` | [`token`] | The logical resource id associated with the resource. Example: `M12345` `patient` | This, or `_id` | [`reference`] | The patient for the vaccination record. Example: `12345` - `date` | No | [`date`] | Date range into which the immunization administration date falls. Must be prefixed by 'ge' or 'le'. - `_revinclude` | No | [`token`] | Provenance resource entries to be returned as part of the bundle. Example:_revinclude=Provenance:target - `target-disease` | No | [`token`] | The target disease the dose is being administered against. Example: `http://hl7.org/fhir/sid/cvx|213` - -Notes: - -* The `date` parameter may be provided: - * once with a prefix `ge` or `le` representing the earliest date or latest date. (e.g. `date=ge2015-01-01`, `date=le2016-01-01`) - * twice with the prefixes `ge`, `le` to indicate a specific range. (e.g. `date=ge2015-01-01&date=le2016-01-01`) -* The `_revinclude` parameter may be provided once with the value `Provenance:target`. Example: `_revinclude=Provenance:target` -* The `_revinclude` parameter may be provided in combination with the `_id/patient` parameter. Example: `_id=M17255835,M17255827&_revinclude=Provenance:target` -* When `_revinclude` is provided in a request to a closed endpoint, the OAuth2 token must include the `user/Provenance.read` scope. -* **Currently the `patient/Provenance.read` scope is not supported and hence `_revinclude` cannot be utilised for patient persona.** -* The `target-disease` parameter - * Searching by Millennium proprietary codes is not supported + `date` | N | [`date`] | Date range for the immunization administration(s). Example: `date=ge2020-01-01T08:00:00.000Z&date=le2020-01-31T17:00:00.000Z` + `target-disease` | N | [`token`] | The target disease the dose is being administered against. Example: `http://hl7.org/fhir/sid/cvx\|213` + `_revinclude` | N | [`token`] | Provenance resource entries to be returned as part of the bundle. + +_Implementation Notes_ + +- When searching with the `_id` parameter: + - It can be provided with either a single reference, or a comma-separated list of references. Example `_id=M1234` or `_id=M1234,M5678` + - It must not be provided with any other parameters, except with `_revinclude` as indicated below +- When searching with the `patient` parameter: + - It can be provided with only a single reference; a comma-separated list is not supported. +- When searching with the `date` parameter: + - For a single `date` occurrence: + - It must be provided with either the `le` or `ge` prefix to search for vaccination record(s) administrations earlier or later than the given date. + - The `time` component is optional. + - For two `date` occurences: + - It must be provided with `le` and `ge` prefixes to search for vaccination record(s) within a specific range. + - The `time` component is optional, but must be consistent. If one date has a `time` component, so must the other. +- When searching with the `target-disease` parameter + - Searching by Millennium proprietary codes is not supported +- When searching with the `_revinclude` parameter + - May be provided once with the value `Provenance:target`. Example: `_revinclude=Provenance:target` + - May be provided with the `_id` or `patient` parameter. Example: `_id=M17255835&_revinclude=Provenance:target` + +- When `_revinclude` is provided in a request to the closed endpoint, the OAuth2 token must include the `user/Provenance.read` scope. Currently `patient/Provenance.read` is not supported and hence `_revinclude` cannot be utilized for patient persona. ### Headers @@ -102,7 +117,6 @@ Notes: <%= headers status: 200 %> <%= json(:R4_IMMUNIZATION_BUNDLE) %> -<%= disclaimer %> ### Example with RevInclude @@ -118,7 +132,6 @@ Notes: <%= headers status: 200 %> <%= json(:r4_immunization_revinclude_bundle) %> -<%= disclaimer %> #### Patient Authorization Request @@ -129,12 +142,6 @@ Notes: <%= headers status: 200 %> <%= json(:R4_IMMUNIZATION_PATIENT_BUNDLE) %> -<%= disclaimer %> - -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - ## Retrieve by id List an individual Immunization by its id: @@ -160,8 +167,6 @@ List an individual Immunization by its id: <%= headers status: 200 %> <%= json(:R4_IMMUNIZATION_ENTRY) %> -<%= disclaimer %> - #### Patient Authorization Request For Completed Status GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Immunization/M197197986 @@ -171,7 +176,6 @@ List an individual Immunization by its id: <%= headers status: 200 %> <%= json(:R4_IMMUNIZATION_PATIENT_ENTRY) %> -<%= disclaimer %> #### Patient Authorization Request For Entered in Error Status @@ -182,8 +186,6 @@ List an individual Immunization by its id: <%= headers status: 200 %> <%= json(:R4_IMMUNIZATION_ENTERED_IN_ERROR_STATUS) %> -<%= disclaimer %> - #### Patient Authorization Request For Not done Status GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Immunization/HM178147794 @@ -193,12 +195,6 @@ List an individual Immunization by its id: <%= headers status: 200 %> <%= json(:R4_IMMUNIZATION_NOT_DONE_STATUS) %> -<%= disclaimer %> - -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - ## Create Create a new Immunization. @@ -239,15 +235,11 @@ Etag: W/"1" Last-Modified: Sun, 30 Jun 2019 10:35:00 GMT Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Immunization/147391087 Vary: Origin -X-Request-Id: 1638e30e497b93ff4383b2ff0eaeea68 +X-Request-Id: 11111111111111111111111111111111 The `ETag` response header indicates the current `If-Match` version to use on subsequent updates. -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - ## Update Update an Immunization. @@ -288,17 +280,15 @@ Date: Sun, 30 Jun 2019 10:40:00 GMT Etag: W/"2" Last-Modified: Sun, 30 Jun 2019 10:40:00 GMT Vary: Origin -X-Request-Id: 1638e30e497b93ff4383b2ff0eaeea91 +X-Request-Id: 11111111111111111111111111111111 The `ETag` response header indicates the current `If-Match` version to use on subsequent updates. -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - [`token`]: http://hl7.org/fhir/R4/search.html#token [`reference`]: http://hl7.org/fhir/R4/search.html#reference [`date`]: http://hl7.org/fhir/R4/search.html#date [errors]: ../../../#client-errors [OperationOutcomes]: ../../../#operation-outcomes +[`MedicationAdministration`]: ../medication-administration/#overview +[`AllergyIntolerance`]: ../../summary/allergy-intolerance/#overview diff --git a/lib/resources/r4/immunization.yaml b/lib/resources/r4/immunization.yaml index 6b9078764..805108993 100644 --- a/lib/resources/r4/immunization.yaml +++ b/lib/resources/r4/immunization.yaml @@ -1,11 +1,11 @@ --- name: Immunization -field_name_base_url: http://hl7.org/fhir/R4/immunization-definitions.html#Immunization +field_name_base_url: https://hl7.org/fhir/R4/immunization-definitions.html#Immunization fields: - name: resourceType required: 'Yes' type: string - url: http://hl7.org/fhir/r4/json.html#resources + url: https://hl7.org/fhir/r4/json.html#resources description: The type of the FHIR resource. action: - create @@ -65,7 +65,7 @@ fields: terminology: - display: Immunization Status Reason system: http://terminology.hl7.org/CodeSystem/v3-ActReason - info_link: http://hl7.org/fhir/r4/valueset-immunization-status-reason.html + info_link: https://hl7.org/fhir/r4/valueset-immunization-status-reason.html - display: Millennium Expire Reasons system: https://fhir.cerner.com/<EHR source id>/codeSet/30440 info_link: https://fhir.cerner.com/millennium/r4/proprietary-codes-and-systems/#code-set-30440-expire-reasons @@ -94,10 +94,10 @@ fields: terminology: - display: CVX system: http://hl7.org/fhir/sid/cvx - info_link: http://hl7.org/fhir/r4/cvx.html + info_link: https://hl7.org/fhir/r4/cvx.html - display: NDC system: http://hl7.org/fhir/sid/ndc - info_link: http://hl7.org/fhir/r4/ndc.html + info_link: https://hl7.org/fhir/r4/ndc.html - display: Millennium Clinical Event Code system: https://fhir.cerner.com/<EHR source id>/codeSet/72 info_link: https://fhir.cerner.com/millennium/r4/proprietary-codes-and-systems/#code-set-72-clinical-event-codes @@ -133,8 +133,8 @@ fields: } note: | - name: encounter @@ -183,13 +183,13 @@ fields: "text": "Primary Care Provider" } } - note: Should not be supplied when primarySource is set to true + note: Should not be supplied when primarySource is set to true. binding: description: The source of an immunization record when not reported by the person who administered the vaccine. terminology: - display: Immunization Report Origin system: http://terminology.hl7.org/CodeSystem/immunization-origin - info_link: http://hl7.org/fhir/R4/valueset-immunization-origin.html + info_link: https://hl7.org/fhir/R4/valueset-immunization-origin.html - display: Millennium Source from which a Result Originated system: https://fhir.cerner.com/<EHR source id>/codeSet/30200 info_link: https://fhir.cerner.com/millennium/r4/proprietary-codes-and-systems/#code-set-30200-result-source @@ -259,7 +259,7 @@ fields: terminology: - display: SNOMED CT system: http://snomed.info/sct - info_link: http://hl7.org/fhir/r4/snomedct.html + info_link: https://hl7.org/fhir/r4/snomedct.html - display: Millennium Medication Site system: https://fhir.cerner.com/<EHR source id>/codeSet/97 info_link: https://fhir.cerner.com/millennium/r4/proprietary-codes-and-systems/#code-set-97-medication-administration-site @@ -288,7 +288,7 @@ fields: terminology: - display: SNOMED CT system: http://snomed.info/sct - info_link: http://hl7.org/fhir/r4/snomedct.html + info_link: https://hl7.org/fhir/r4/snomedct.html - display: Millennium Route system: https://fhir.cerner.com/<EHR source id>/codeSet/4001 info_link: https://fhir.cerner.com/millennium/r4/proprietary-codes-and-systems/#code-set-4001-medication-administration-route @@ -426,10 +426,10 @@ fields: terminology: - display: CVX system: http://hl7.org/fhir/sid/cvx - info_link: http://hl7.org/fhir/r4/cvx.html + info_link: https://hl7.org/fhir/r4/cvx.html - display: SNOMED CT system: http://snomed.info/sct - info_link: http://hl7.org/fhir/r4/snomedct.html + info_link: https://hl7.org/fhir/r4/snomedct.html - display: Millennium Vaccine Group Code system: https://fhir.cerner.com/<EHR source id>/codeSet/4003106 info_link: https://fhir.cerner.com/millennium/r4/proprietary-codes-and-systems/#code-set-4003106-vaccine-group From 24f06e3c5336a5a3ef2023176619e749116fdf99 Mon Sep 17 00:00:00 2001 From: kckeim Date: Mon, 23 Oct 2023 14:16:15 -0500 Subject: [PATCH 2/8] Removed extraneous escape for a vertical pipe --- content/millennium/r4/clinical/medications/immunization.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/millennium/r4/clinical/medications/immunization.md b/content/millennium/r4/clinical/medications/immunization.md index 3d3a418e0..6162c4767 100644 --- a/content/millennium/r4/clinical/medications/immunization.md +++ b/content/millennium/r4/clinical/medications/immunization.md @@ -77,7 +77,7 @@ Search for Immunizations that meet supplied query parameters: `_id` | This, or `patient` | [`token`] | The logical resource id associated with the resource. Example: `M12345` `patient` | This, or `_id` | [`reference`] | The patient for the vaccination record. Example: `12345` `date` | N | [`date`] | Date range for the immunization administration(s). Example: `date=ge2020-01-01T08:00:00.000Z&date=le2020-01-31T17:00:00.000Z` - `target-disease` | N | [`token`] | The target disease the dose is being administered against. Example: `http://hl7.org/fhir/sid/cvx\|213` + `target-disease` | N | [`token`] | The target disease the dose is being administered against. Example: `http://hl7.org/fhir/sid/cvx|213` `_revinclude` | N | [`token`] | Provenance resource entries to be returned as part of the bundle. _Implementation Notes_ From 136c8f7897eb1d842f0d1eb9c928e14c30da3644 Mon Sep 17 00:00:00 2001 From: kckeim Date: Mon, 23 Oct 2023 15:56:34 -0500 Subject: [PATCH 3/8] Pre-emptive edits ahead of Summer/Casey's review --- .../r4/clinical/medications/immunization.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/content/millennium/r4/clinical/medications/immunization.md b/content/millennium/r4/clinical/medications/immunization.md index 6162c4767..113c2e8bd 100644 --- a/content/millennium/r4/clinical/medications/immunization.md +++ b/content/millennium/r4/clinical/medications/immunization.md @@ -9,7 +9,7 @@ title: Immunization | R4 API ## Overview -The Immunization resource is intended to cover the recording of current and historical administration of vaccines to patients across all healthcare disciplines in all care settings and all regions. This resource contains the functionality to query a patient's immunization history. Detailed administration records may be found in the [`MedicationAdministration`] resource, while this Immunization resource would represent the known vaccination history regardless of where the administration itself was done. +The Immunization resource is intended to cover the recording of current and historical administration of vaccines to patients across all healthcare disciplines, in all care settings, and all regions. This resource contains the functionality to query a patient's immunization history. Detailed administration records may be found in the [`MedicationAdministration`] resource, while this Immunization resource would represent the known vaccination history regardless of where the administration itself was done. An immunization reaction may indicate an allergy or intolerance. If so, a separate [`AllergyIntolerance`] resource instance should be created as well. @@ -72,13 +72,13 @@ Search for Immunizations that meet supplied query parameters: ### Parameters - Name | Required? | Type | Description -------------------|--------------------|---------------|----------------------------------------------------------------------------------------------------- - `_id` | This, or `patient` | [`token`] | The logical resource id associated with the resource. Example: `M12345` - `patient` | This, or `_id` | [`reference`] | The patient for the vaccination record. Example: `12345` - `date` | N | [`date`] | Date range for the immunization administration(s). Example: `date=ge2020-01-01T08:00:00.000Z&date=le2020-01-31T17:00:00.000Z` - `target-disease` | N | [`token`] | The target disease the dose is being administered against. Example: `http://hl7.org/fhir/sid/cvx|213` - `_revinclude` | N | [`token`] | Provenance resource entries to be returned as part of the bundle. + Name | Required? | Type | Description +------------------|---------------|---------------|----------------------------------------------------------------------------------------------------- + `_id` | Conditionally | [`token`] | The logical resource ID associated with the resource. This parameter is required if the `patient` parameter is not used. Example: `M12345` + `patient` | Conditionally | [`reference`] | The patient for the vaccination record. This parameter is required if the `_id` parameter is not used. Example: `12345` + `date` | No | [`date`] | Date range for the immunization administration(s). Example: `date=ge2020-01-01T08:00:00.000Z&date=le2020-01-31T17:00:00.000Z` + `target-disease` | No | [`token`] | The target disease the dose is being administered against. Example: `http://hl7.org/fhir/sid/cvx|213` + `_revinclude` | No | [`token`] | Provenance resource entries to be returned as part of the bundle. _Implementation Notes_ @@ -142,9 +142,9 @@ _Implementation Notes_ <%= headers status: 200 %> <%= json(:R4_IMMUNIZATION_PATIENT_BUNDLE) %> -## Retrieve by id +## Retrieve by ID -List an individual Immunization by its id: +List an individual Immunization by the associated ID: GET /Immunization/:id From 7bbecf8a24471a8eb57dd4fc2c99e2441f5c472e Mon Sep 17 00:00:00 2001 From: "Deitrich, Casey" Date: Mon, 23 Oct 2023 16:37:32 -0500 Subject: [PATCH 4/8] PRODOC-202502: Style and formatting edits. --- .../r4/clinical/medications/immunization.md | 54 +++++++++---------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/content/millennium/r4/clinical/medications/immunization.md b/content/millennium/r4/clinical/medications/immunization.md index 113c2e8bd..749f46e85 100644 --- a/content/millennium/r4/clinical/medications/immunization.md +++ b/content/millennium/r4/clinical/medications/immunization.md @@ -9,13 +9,13 @@ title: Immunization | R4 API ## Overview -The Immunization resource is intended to cover the recording of current and historical administration of vaccines to patients across all healthcare disciplines, in all care settings, and all regions. This resource contains the functionality to query a patient's immunization history. Detailed administration records may be found in the [`MedicationAdministration`] resource, while this Immunization resource would represent the known vaccination history regardless of where the administration itself was done. +The Immunization resource is intended to cover the recording of current and historical administration of vaccines to patients across all healthcare disciplines, in all care settings, and all regions. This resource contains the functionality to query a patient's immunization history. You can find detailed administration records in the [`MedicationAdministration`] resource, while this Immunization resource represents the known vaccination history regardless of where the administration itself was done. -An immunization reaction may indicate an allergy or intolerance. If so, a separate [`AllergyIntolerance`] resource instance should be created as well. +An immunization reaction may indicate an allergy or intolerance. If so, create a separate [`AllergyIntolerance`] resource instance as well. -Note that while the terms "immunization" and "vaccination" are not clinically identical, for the purposes of FHIR resources, the terms are used synonymously. +Note that while the terms immunization and vaccination are not clinically identical, for the purposes of FHIR resources, the terms are used synonymously. - * The following [HL7® FHIR® US Core Implementation Guide STU 4.0.0](https://hl7.org/fhir/us/core/STU4/) Profiles are supported by this resource: + * This resource supports the following [HL7 FHIR US Core Implementation Guide STU 4.0.0](https://hl7.org/fhir/us/core/STU4/) profiles: * [US Core Immunization Profile](http://hl7.org/fhir/us/core/STU4/StructureDefinition-us-core-immunization.html) @@ -62,7 +62,7 @@ The common [errors] and [OperationOutcomes] may be returned. ## Search -Search for Immunizations that meet supplied query parameters: +Search for immunizations that meet supplied query parameters: GET /Immunization?:parameters @@ -72,35 +72,35 @@ Search for Immunizations that meet supplied query parameters: ### Parameters - Name | Required? | Type | Description -------------------|---------------|---------------|----------------------------------------------------------------------------------------------------- - `_id` | Conditionally | [`token`] | The logical resource ID associated with the resource. This parameter is required if the `patient` parameter is not used. Example: `M12345` - `patient` | Conditionally | [`reference`] | The patient for the vaccination record. This parameter is required if the `_id` parameter is not used. Example: `12345` - `date` | No | [`date`] | Date range for the immunization administration(s). Example: `date=ge2020-01-01T08:00:00.000Z&date=le2020-01-31T17:00:00.000Z` - `target-disease` | No | [`token`] | The target disease the dose is being administered against. Example: `http://hl7.org/fhir/sid/cvx|213` - `_revinclude` | No | [`token`] | Provenance resource entries to be returned as part of the bundle. + Name | Required? | Type | Description +------------------|--------------------|---------------|----------------------------------------------------------------------------------------------------- + `_id` | Conditionally | [`token`] | The logical resource ID associated with the resource. This parameter is required if the `patient` parameter is not used. Example: `M12345` + `patient` | Conditionally | [`reference`] | The patient for the vaccination record. This parameter is required if the `_id` parameter is not used. Example: `12345` + `date` | No | [`date`] | The date range for the immunization administration or administrations. Example: `date=ge2020-01-01T08:00:00.000Z&date=le2020-01-31T17:00:00.000Z` + `target-disease` | No | [`token`] | The target disease that the dose is being administered against. Example: `http://hl7.org/fhir/sid/cvx|213` + `_revinclude` | No | [`token`] | The Provenance resource entries that are returned as part of the bundle. _Implementation Notes_ - When searching with the `_id` parameter: - - It can be provided with either a single reference, or a comma-separated list of references. Example `_id=M1234` or `_id=M1234,M5678` - - It must not be provided with any other parameters, except with `_revinclude` as indicated below + - It can be provided with either a single reference, or a comma-separated list of references. Example: `_id=M1234` or `_id=M1234,M5678` + - It must not be provided with any other parameters, except with `_revinclude` as indicated below. - When searching with the `patient` parameter: - It can be provided with only a single reference; a comma-separated list is not supported. - When searching with the `date` parameter: - For a single `date` occurrence: - - It must be provided with either the `le` or `ge` prefix to search for vaccination record(s) administrations earlier or later than the given date. + - It must be provided with either the `le` or `ge` prefix to search for vaccination record administrations earlier or later than the given date. - The `time` component is optional. - - For two `date` occurences: - - It must be provided with `le` and `ge` prefixes to search for vaccination record(s) within a specific range. + - For two `date` occurrences: + - It must be provided with `le` and `ge` prefixes to search for vaccination records within a specific range. - The `time` component is optional, but must be consistent. If one date has a `time` component, so must the other. -- When searching with the `target-disease` parameter - - Searching by Millennium proprietary codes is not supported -- When searching with the `_revinclude` parameter - - May be provided once with the value `Provenance:target`. Example: `_revinclude=Provenance:target` - - May be provided with the `_id` or `patient` parameter. Example: `_id=M17255835&_revinclude=Provenance:target` +- When searching with the `target-disease` parameter: + - Searching by Cerner Millennium proprietary codes is not supported. +- When searching with the `_revinclude` parameter: + - It can be provided once with the `Provenance:target` value. Example: `_revinclude=Provenance:target` + - It can be provided with the `_id` or `patient` parameter. Example: `_id=M17255835&_revinclude=Provenance:target` -- When `_revinclude` is provided in a request to the closed endpoint, the OAuth2 token must include the `user/Provenance.read` scope. Currently `patient/Provenance.read` is not supported and hence `_revinclude` cannot be utilized for patient persona. +- When `_revinclude` is provided in a request to the closed endpoint, the OAuth2 token must include the `user/Provenance.read` scope. Currently, `patient/Provenance.read` is not supported; hence, `_revinclude` cannot be used for patient persona. ### Headers @@ -144,7 +144,7 @@ _Implementation Notes_ ## Retrieve by ID -List an individual Immunization by the associated ID: +List an individual immunization by the associated ID: GET /Immunization/:id @@ -186,7 +186,7 @@ List an individual Immunization by the associated ID: <%= headers status: 200 %> <%= json(:R4_IMMUNIZATION_ENTERED_IN_ERROR_STATUS) %> -#### Patient Authorization Request For Not done Status +#### Patient Authorization Request For Not Done Status GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Immunization/HM178147794 @@ -197,7 +197,7 @@ List an individual Immunization by the associated ID: ## Create -Create a new Immunization. +Create a new immunization. POST /Immunization @@ -242,7 +242,7 @@ The `ETag` response header indicates the current `If-Match` version to use on su ## Update -Update an Immunization. +Update an immunization. PUT /Immunization/:id From 6c807cf5e15496a3987d6183abf7a8d7b0b54ea9 Mon Sep 17 00:00:00 2001 From: kckeim Date: Thu, 26 Oct 2023 20:13:28 -0500 Subject: [PATCH 5/8] Updated R4 Markdown and YAML - flipped "Encounter" back to "encounter" for matching the parameter/field (yaml file) - UUID formatted the x-request-id - added opc-request-id --- content/millennium/r4/clinical/medications/immunization.md | 3 ++- lib/resources/r4/immunization.yaml | 4 ++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/content/millennium/r4/clinical/medications/immunization.md b/content/millennium/r4/clinical/medications/immunization.md index 749f46e85..490432289 100644 --- a/content/millennium/r4/clinical/medications/immunization.md +++ b/content/millennium/r4/clinical/medications/immunization.md @@ -235,7 +235,8 @@ Etag: W/"1" Last-Modified: Sun, 30 Jun 2019 10:35:00 GMT Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Immunization/147391087 Vary: Origin -X-Request-Id: 11111111111111111111111111111111 +opc-request-id: /11111111111111111111111111111111/11111111111111111111111111111111 +X-Request-Id: 11111111-1111-1111-1111-111111111111 The `ETag` response header indicates the current `If-Match` version to use on subsequent updates. diff --git a/lib/resources/r4/immunization.yaml b/lib/resources/r4/immunization.yaml index 805108993..bd2ca410c 100644 --- a/lib/resources/r4/immunization.yaml +++ b/lib/resources/r4/immunization.yaml @@ -133,8 +133,8 @@ fields: } note: |
    -
  • Encounter is required field to create charted immunizations.
    • -
  • Encounter is not a required field to create staged immunizations.
    • +
  • encounter is required field to create charted immunizations.
    • +
  • encounter is not a required field to create staged immunizations.
- name: encounter From f6eab55a41c5a6258ff8f3a5068c77675a90a853 Mon Sep 17 00:00:00 2001 From: kckeim Date: Tue, 14 Nov 2023 16:43:18 -0600 Subject: [PATCH 6/8] Uppercase'd ID in fields list --- content/millennium/r4/clinical/medications/immunization.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/millennium/r4/clinical/medications/immunization.md b/content/millennium/r4/clinical/medications/immunization.md index 490432289..087e3039b 100644 --- a/content/millennium/r4/clinical/medications/immunization.md +++ b/content/millennium/r4/clinical/medications/immunization.md @@ -21,7 +21,7 @@ Note that while the terms immunization and vaccination are not clinically identi The following fields are returned if valued: -* [Id](https://hl7.org/fhir/R4/resource-definitions.html#Resource.id){:target="_blank"} +* [ID](https://hl7.org/fhir/R4/resource-definitions.html#Resource.id){:target="_blank"} * [Immunization Record Identifier](https://hl7.org/fhir/R4/immunization-definitions.html#Immunization.identifier){:target="_blank"} * [Status](https://hl7.org/fhir/R4/immunization-definitions.html#Immunization.status){:target="_blank"} * [Status reason](https://hl7.org/fhir/R4/immunization-definitions.html#Immunization.statusReason){:target="_blank"} From d80f7f5ceb0ab3ef98378b75ab0e3cf1e574cd7e Mon Sep 17 00:00:00 2001 From: kckeim Date: Tue, 14 Nov 2023 16:47:40 -0600 Subject: [PATCH 7/8] un-Code the "time component" language --- content/millennium/r4/clinical/medications/immunization.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/millennium/r4/clinical/medications/immunization.md b/content/millennium/r4/clinical/medications/immunization.md index 087e3039b..5d5d4833b 100644 --- a/content/millennium/r4/clinical/medications/immunization.md +++ b/content/millennium/r4/clinical/medications/immunization.md @@ -90,10 +90,10 @@ _Implementation Notes_ - When searching with the `date` parameter: - For a single `date` occurrence: - It must be provided with either the `le` or `ge` prefix to search for vaccination record administrations earlier or later than the given date. - - The `time` component is optional. + - The time component is optional. - For two `date` occurrences: - It must be provided with `le` and `ge` prefixes to search for vaccination records within a specific range. - - The `time` component is optional, but must be consistent. If one date has a `time` component, so must the other. + - The time component is optional, but must be consistent. If one date has a time component, so must the other. - When searching with the `target-disease` parameter: - Searching by Cerner Millennium proprietary codes is not supported. - When searching with the `_revinclude` parameter: From 2a8808b87abb82ff64fe82a26f1cbffb8aa2e998 Mon Sep 17 00:00:00 2001 From: Aaron McGinn Date: Thu, 16 Nov 2023 12:55:05 -0600 Subject: [PATCH 8/8] Update X-Request-Id to UUID in immunization.md --- content/millennium/r4/clinical/medications/immunization.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/millennium/r4/clinical/medications/immunization.md b/content/millennium/r4/clinical/medications/immunization.md index 5d5d4833b..04b3b8970 100644 --- a/content/millennium/r4/clinical/medications/immunization.md +++ b/content/millennium/r4/clinical/medications/immunization.md @@ -281,7 +281,7 @@ Date: Sun, 30 Jun 2019 10:40:00 GMT Etag: W/"2" Last-Modified: Sun, 30 Jun 2019 10:40:00 GMT Vary: Origin -X-Request-Id: 11111111111111111111111111111111 +X-Request-Id: b72617f9-1a52-46ca-bb52-b0b3f976f9fb The `ETag` response header indicates the current `If-Match` version to use on subsequent updates.