diff --git a/content/millennium/dstu2/care-provision/goal.md b/content/millennium/dstu2/care-provision/goal.md index 9a390a9c8..1d156545f 100644 --- a/content/millennium/dstu2/care-provision/goal.md +++ b/content/millennium/dstu2/care-provision/goal.md @@ -9,11 +9,11 @@ title: Goal | DSTU 2 API ## Overview -The Goal resource describes intended objectives for a patient. A Goal is typically expressed as a desired outcome or health state to be achieved by a patient over a period or at a specific point in time. A Goal may address preventative health or mitigation of a diagnosis or problem. Goals can be non-health care related (e.g. dance at a wedding). +The Goal resource describes intended objectives for a patient. A goal is typically expressed as a desired outcome or health state to be achieved by a patient over a period or at a specific point in time. A goal may address preventative health or mitigation of a diagnosis or problem. Goals can be non-healthcare related (for example, dance at a wedding). The following fields are returned if valued: -* [id](http://hl7.org/fhir/dstu2/resource-definitions.html#Resource.id){:target="_blank"} +* [Goal ID](http://hl7.org/fhir/dstu2/resource-definitions.html#Resource.id){:target="_blank"} * [Subject (patient)](http://hl7.org/fhir/DSTU2/goal-definitions.html#Goal.subject){:target="_blank"} * [Start date](http://hl7.org/fhir/DSTU2/goal-definitions.html#Goal.start_x_){:target="_blank"} * [Target date](http://hl7.org/fhir/DSTU2/goal-definitions.html#Goal.target_x_){:target="_blank"} @@ -24,13 +24,19 @@ The following fields are returned if valued: * [Author](http://hl7.org/fhir/DSTU2/goal-definitions.html#Goal.author){:target="_blank"} * [Note](http://hl7.org/fhir/DSTU2/goal-definitions.html#Goal.note){:target="_blank"} +<%= disclaimer %> + +### Errors + +The common [errors] and [OperationOutcomes] may be returned. + ## Terminology Bindings <%= terminology_table(:goal, :dstu2) %> ## Search -Search for Goals that meet supplied query parameters: +Search for goals that meet supplied query parameters. GET /Goal?:parameters @@ -40,18 +46,18 @@ Search for Goals that meet supplied query parameters: ### Parameters - Name | Required? | Type | Description --------------------|------------------------------------------|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- - `_id` | This, or one of `patient`, or `subject`. | [`token`] | The logical resource id associated with the Goal. Example: `_id=7891` - `patient` | This, or one of `_id`, or `subject`. | [`reference`] | The patient who has the goal. Example: `patient=12345` - `subject:Patient` | This, or one of `_id`, or `patient`. | [`reference`] | The subject who this goal is intended for. Must represent a Patient resource. May use the `:Patient` modifier. Example: `subject=Patient/12345` or `subject:Patient=12345` - `targetdate` | N | [`date`] | A date or date range from which to find Goals. Example: `targetdate=ge2016-10-01&targetdate=le2016-12-01` + Name | Required? | Type | Description +-------------------|------------------|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + `_id` | Conditionally | [`token`] | The logical resource ID associated with the goal. This parameter is required if `patient` or `subject` are not used. Example: `_id=7891` + `patient` | Conditionally | [`reference`] | The patient who has the goal. This parameter is required if `_id` or `subject` are not used. Example: `patient=12345` + `subject:Patient` | Condtionally | [`reference`] | The subject who this goal is intended for. Must represent a Patient resource. This parameter is required if `_id` or `patient` are not used. Examples: `subject=Patient/12345` or `subject:Patient=12345` + `targetdate` | No | [`date`] | A date or date range from which to find goals. Example: `targetdate=ge2016-10-01&targetdate=le2016-12-01` Notes: - - The `_id` parameter may not be provided at the same time as the `patient`, `subject`, or `targetdate` parameters. - - - The `targetdate` parameter may be provided once with a prefix to imply a date range or without a prefix to search for goals at a specific date. Alternately it may be provided twice with `le`, `lt`, `ge`, or `gt` prefixes to search for goals within specific range. The date and prefix pairs must create a closed range. +* The `targetdate` parameter: + * May be provided once with a prefix to imply a date range or without a prefix to search for goals at a specific date. + * Alternatively, it may be provided twice with `le`, `lt`, `ge`, or `gt` prefixes to search for goals within a specific range. The date and prefix pairs must create a closed range. ### Headers @@ -68,10 +74,7 @@ Notes: <%= headers status: 200 %> <%= json(:dstu2_goal_bundle) %> -<%= disclaimer %> - - -### Example Search by Id +### Example Search by ID #### Request @@ -82,15 +85,9 @@ Notes: <%= headers status: 200 %> <%= json(:dstu2_goal_bundle_by_id) %> -<%= disclaimer %> - -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - -## Retrieve by id +## Retrieve by ID -List an individual Goal by its id: +List an individual goal by its ID. GET /Goal/:id @@ -113,12 +110,6 @@ List an individual Goal by its id: <%= headers status: 200 %> <%= json(:dstu2_goal) %> -<%= disclaimer %> - -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - [`date`]: http://hl7.org/fhir/dstu2/search.html#date [`reference`]: http://hl7.org/fhir/DSTU2/search.html#reference [`token`]: http://hl7.org/fhir/DSTU2/search.html#token diff --git a/content/millennium/dstu2/conformance/structure-definition.md b/content/millennium/dstu2/conformance/structure-definition.md index 2df4f30ff..695796a8a 100644 --- a/content/millennium/dstu2/conformance/structure-definition.md +++ b/content/millennium/dstu2/conformance/structure-definition.md @@ -9,37 +9,37 @@ title: StructureDefinition | DSTU 2 API ## Overview -The StructureDefinition resource describes a FHIR structure including data elements and their usage. Our current implementation uses this resource to define custom extensions. +The StructureDefinition resource describes a FHIR structure including data elements and their usage. This resource is used to define custom extensions. The following fields are returned if valued: -* [Id](http://hl7.org/fhir/dstu2/resource-definitions.html#Resource.id){:target="_blank"} -* [Publisher](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.publisher){:target="_blank"} -* [Snapshot](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.snapshot){:target="_blank"} -* [Date](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.date){:target="_blank"} -* [Fhir version](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.fhirVersion){:target="_blank"} -* [Constrained type](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.constrainedType){:target="_blank"} -* [Description](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.description){:target="_blank"} -* [Status](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.status){:target="_blank"} -* [Context type](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.contextType){:target="_blank"} -* [Context](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.context){:target="_blank"} -* [URL](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.url){:target="_blank"} -* [Kind](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.kind){:target="_blank"} -* [Differential](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.differential){:target="_blank"} -* [Abstract](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.abstract){:target="_blank"} -* [Base](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.base){:target="_blank"} -* [Name](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.name){:target="_blank"} - -## Retrieve by id - -List an individual StructureDefinition by its id: +* [ID](https://hl7.org/fhir/dstu2/resource-definitions.html#Resource.id){:target="_blank"} +* [Publisher](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.publisher){:target="_blank"} +* [Snapshot](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.snapshot){:target="_blank"} +* [Date](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.date){:target="_blank"} +* [FHIR version](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.fhirVersion){:target="_blank"} +* [Constrained type](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.constrainedType){:target="_blank"} +* [Description](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.description){:target="_blank"} +* [Status](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.status){:target="_blank"} +* [Context type](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.contextType){:target="_blank"} +* [Context](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.context){:target="_blank"} +* [URL](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.url){:target="_blank"} +* [Kind](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.kind){:target="_blank"} +* [Differential](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.differential){:target="_blank"} +* [Abstract](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.abstract){:target="_blank"} +* [Base](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.base){:target="_blank"} +* [Name](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.name){:target="_blank"} + +## Retrieve by ID + +List an individual structure definition by its ID. GET /StructureDefinition/:id -_Implementation Notes_ +_Notes_ -* Authentication is not required to access the StructureDefinition resource -* This resource can be retrieved by its defining URL or from the StructureDefinition resource located at the [service root URL](../../#service-root-url). For example, both of these URLs work: +* Authentication is not required to access the StructureDefinition resource. +* You can retrieve this resource by its defining URL or from the StructureDefinition resource located at the [service root URL](../../#service-root-url). For example, both of these URLs work: `https://fhir-ehr.cerner.com/dstu2/StructureDefinition/patient-friendly-display` @@ -49,15 +49,12 @@ _Implementation Notes_ Authorization is not required. -<%= authorization_types(provider: true, patient: true, system: true) %> - ### Headers <%= headers head: {Accept: 'application/json+fhir'} %> ### Example - #### Request GET https://fhir-ehr.cerner.com/dstu2/StructureDefinition/patient-friendly-display @@ -67,17 +64,15 @@ Authorization is not required. <%= headers status: 200 %> <%= json(:dstu2_structure_definition_bundle) %> -<%= disclaimer %> - ## List of StructureDefinitions ID | Description ----------------------------------|---------------------------------------------- -[`patient-friendly-display`] | Display string suitable for patient viewing. -[`scheduling-location`] | Reference to the location of an appointment being scheduled. -[`medication-statement-category`] | Category of an order. -[`infuse-over-time`] | The length of time in minutes it took to infuse a medication. -[`encounter-guarantor`] | The guarantors of an encounter. Contains a reference to a Patient, Person, or Organization and a period when the guarantor is effective. +[`patient-friendly-display`] | The display name suitable for patient viewing. +[`scheduling-location`] | The reference to the location of a scheduled appointment. +[`medication-statement-category`] | The category of an order. +[`infuse-over-time`] | The length of time in minutes to infuse a medication. +[`encounter-guarantor`] | The guarantors of an encounter. Contains a reference to a patient, person, or organization and a period when the guarantor is effective. [`patient-friendly-display`]: https://fhir-ehr.cerner.com/dstu2/StructureDefinition/patient-friendly-display?_format=json [`scheduling-location`]: https://fhir-ehr.cerner.com/dstu2/StructureDefinition/scheduling-location?_format=json diff --git a/content/millennium/dstu2/entities/person.md b/content/millennium/dstu2/entities/person.md index 835023cac..ee1ed219a 100644 --- a/content/millennium/dstu2/entities/person.md +++ b/content/millennium/dstu2/entities/person.md @@ -9,18 +9,24 @@ title: Person | DSTU 2 API ## Overview -The Person resource identifies an individual outside of a specific health care context providing a mechanism to link person resources across different facilities or organizations. +The Person resource identifies an individual outside of a specific healthcare context and provides a mechanism to associate person resources across different facilities or organizations. The following fields are returned if valued: -* [Person id](http://hl7.org/fhir/dstu2/resource-definitions.html#Resource.id){:target="_blank"} -* [Identifier (Cerner alias Federated Person Principal)](http://hl7.org/fhir/DSTU2/person-definitions.html#Person.identifier){:target="_blank"} -* [Name](http://hl7.org/fhir/DSTU2/person-definitions.html#Person.name){:target="_blank"} -* [Telecom](http://hl7.org/fhir/DSTU2/person-definitions.html#Person.telecom){:target="_blank"} -* [Gender](http://hl7.org/fhir/DSTU2/person-definitions.html#Person.gender){:target="_blank"} -* [Date of birth](http://hl7.org/fhir/DSTU2/person-definitions.html#Person.birthDate){:target="_blank"} -* [Address](http://hl7.org/fhir/DSTU2/person-definitions.html#Person.address){:target="_blank"} -* [Active](http://hl7.org/fhir/DSTU2/person-definitions.html#Person.active){:target="_blank"} +* [Person ID](https://hl7.org/fhir/dstu2/resource-definitions.html#Resource.id){:target="_blank"} +* [Identifier](https://hl7.org/fhir/DSTU2/person-definitions.html#Person.identifier){:target="_blank"} +* [Name](https://hl7.org/fhir/DSTU2/person-definitions.html#Person.name){:target="_blank"} +* [Telecom](https://hl7.org/fhir/DSTU2/person-definitions.html#Person.telecom){:target="_blank"} +* [Gender](https://hl7.org/fhir/DSTU2/person-definitions.html#Person.gender){:target="_blank"} +* [Date of birth](https://hl7.org/fhir/DSTU2/person-definitions.html#Person.birthDate){:target="_blank"} +* [Address](https://hl7.org/fhir/DSTU2/person-definitions.html#Person.address){:target="_blank"} +* [Active](https://hl7.org/fhir/DSTU2/person-definitions.html#Person.active){:target="_blank"} + +<%= disclaimer %> + +### Errors + +The common [errors] and [OperationOutcomes] may be returned. ## Terminology Bindings @@ -28,7 +34,7 @@ The following fields are returned if valued: ## Search -Search for Persons that meet supplied query parameters: +Search for persons that meet supplied query parameters. GET /Person?:parameters @@ -38,14 +44,14 @@ Search for Persons that meet supplied query parameters: ### Parameters - Name | Required? | Type | Description ---------------|---------------------------------------------------|------------|------------------------------------------------------------------------------------ - `_id` | No, if populated all other parameters are ignored | [`token`] | The logical resource id associated with the resource. - `identifier` | Yes, or `_id` | [`token`] | The person identifier. Example: `urn:oid:2.16.840.1.113883.3.13.6|01022228` + Name | Required | Type | Description +--------------|---------------|------------|------------------------------------------------------------------------------------ + `_id` | Conditionally | [`token`] | The logical resource ID associated with the resource. This parameter is required if the `identifier` parameter is not used. Example: `_id=12345` + `identifier` | Conditionally | [`token`] | The person identifier. This parameter is required if the `_id` parameter is not used. Example: `urn:oid:2.16.840.1.113883.3.13.6|01022228` Notes: -- `identifier` value must include both a system and a code. Example: `identifier=urn:oid:2.16.840.1.113883.3.13.6|URN:CERNER:...:PI98N2FK5TN` +- The `identifier` value must include both a system and a code. Example: `identifier=urn:oid:2.16.840.1.113883.3.13.6|URN:CERNER:...:PI98N2FK5TN` ### Headers @@ -62,15 +68,9 @@ Notes: <%= headers status: 200 %> <%= json(:dstu2_person_bundle) %> -<%= disclaimer %> +## Retrieve by ID -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - -## Retrieve by id - -List an individual Person by its id: +List an individual person by their ID. GET /Person/:id @@ -93,20 +93,9 @@ List an individual Person by its id: <%= headers status: 200 %> <%= json(:dstu2_person_entry) %> -<%= disclaimer %> - -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - ### Person Combines Example -Cerner Millennium supports the ability to logically merge a person record into another person record when both records are describing the same person. This is known -as a "person combine". If necessary, this merging can later be undone by performing a "person uncombine". When the requested person record has been combined into another -record, an inactive Person entry will be returned which has a link to the current Person entry. Entries for combined patients will only be returned when retrieving -the entries directly by id. They will not be returned when searching with other parameters. - -The ability to perform person combine or uncombine operations is not available through the Cerner Ignite platform. +Oracle Health Millennium Platform supports the ability to logically merge a person record into another person record when both records are describing the same person. This merge is known as a person combine. If necessary, you can perform a person uncombine to undo the merge. When the requested person record is combined into another record, an inactive person entry is returned with a link to the current person entry. Entries for combined patients are only returned when retrieving the entries directly by ID. They are not returned when searching with other parameters. #### Request @@ -117,12 +106,6 @@ The ability to perform person combine or uncombine operations is not available t <%= headers status: 200 %> <%= json(:dstu2_combined_person_entry) %> -<%= disclaimer %> - -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - [`token`]: http://hl7.org/fhir/DSTU2/search.html#token [errors]: ../../#client-errors [OperationOutcomes]: ../../#operation-outcomes diff --git a/content/millennium/dstu2/individuals/patient.md b/content/millennium/dstu2/individuals/patient.md index 22d246aca..f68247f43 100644 --- a/content/millennium/dstu2/individuals/patient.md +++ b/content/millennium/dstu2/individuals/patient.md @@ -9,24 +9,30 @@ title: Patient | DSTU 2 API ## Overview -The Patient resource provides general demographic information about a person receiving health care services from a specific organization. Common demographic fields include patient id, patient name, gender, date of birth, address, phone, primary language and marital status. Cerner Millennium is a patient centric application: thus, many of the other resources will include the patient id in their queries. A person receiving care from multiple organizations may have data available in multiple patient resources in multiple FHIR servers. +The Patient resource provides general demographic information about a person receiving healthcare services from a specific organization. Common demographic fields include patient ID, patient name, gender, date of birth, address, phone, primary language, and marital status. Millennium is a patient-centric application; thus, many other resources include the patient ID in their queries. A person receiving care from multiple organizations may have information available in multiple patient resources in multiple FHIR servers. The following fields are returned if valued: -* [Patient name](http://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.name){:target="_blank"} -* [Patient id](http://hl7.org/fhir/DSTU2/resource-definitions.html#Resource.id){:target="_blank"} -* [Extensions including birth time, birth sex, ethnicity, and race](#extensions) -* [Medical Record number (MRN)](http://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.identifier){:target="_blank"} -* [Contact information (may include phone and email)](http://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.telecom){:target="_blank"} -* [Contact person (guardian, parent or emergency)](http://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.contact){:target="_blank"} -* [Gender (administrative)](http://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.gender){:target="_blank"} -* [Date of Birth](http://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.birthDate){:target="_blank"} -* [Deceased](http://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.deceased_x_){:target="_blank"} -* [Address](http://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.address){:target="_blank"} -* [Communication (preferred language)](http://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.communication.language){:target="_blank"} -* [Marital status](http://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.maritalStatus){:target="_blank"} -* [Primary Care Providers](http://hl7.org/fhir/dstu2/patient-definitions.html#Patient.careProvider){:target="_blank"} -* [Multiple Birth Information](http://hl7.org/fhir/dstu2/patient-definitions.html#Patient.multipleBirth_x_){:target="_blank"} +* [Patient ID](https://hl7.org/fhir/DSTU2/resource-definitions.html#Resource.id){:target="_blank"} +* [Name](https://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.name){:target="_blank"} +* [Extension](#extensions) +* [Identifier](https://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.identifier){:target="_blank"} +* [Telecom](https://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.telecom){:target="_blank"} +* [Contact](https://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.contact){:target="_blank"} +* [Gender](https://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.gender){:target="_blank"} +* [Date of Birth](https://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.birthDate){:target="_blank"} +* [Deceased](https://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.deceased_x_){:target="_blank"} +* [Address](https://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.address){:target="_blank"} +* [Communication language](https://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.communication.language){:target="_blank"} +* [Marital status](https://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.maritalStatus){:target="_blank"} +* [Care Provider](https://hl7.org/fhir/dstu2/patient-definitions.html#Patient.careProvider){:target="_blank"} +* [Multiple Birth](https://hl7.org/fhir/dstu2/patient-definitions.html#Patient.multipleBirth_x_){:target="_blank"} + +<%= disclaimer %> + +### Errors + +The common [errors] and [OperationOutcomes] may be returned. ## Terminology Bindings @@ -42,15 +48,15 @@ The following fields are returned if valued: ## Search -Search for Patients that meet supplied query parameters: +Search for patients who meet supplied query parameters. GET /Patient?:parameters -_Implementation Notes_ +_Notes_ -* The [Patient.animal] modifier element is not supported and will not be returned. -* Direct secure email will not be returned. -* If the current user is a patient or patient proxy, a search may be performed without providing any parameters. The search will return all patients the current user has been granted access to view. +* The [Patient.animal] modifier element is not supported and not returned. +* Direct secure email is not returned. +* If the current user is a patient or patient proxy, a search may be performed without providing any parameters. The search returns all patients that the current user is granted access to view. ### Authorization Types @@ -58,30 +64,30 @@ _Implementation Notes_ ### Parameters - Name | Required? | Type | Description -----------------------|----------------------------------------------|------------|-------------------------------------------------------------------------- - `_id` | This, or any other required search parameter | [`token`] | The logical resource id associated with the resource. - `identifier` | This and/or any other search param, or `_id` | [`token`] | A patient identifier. Example: `urn:oid:1.1.1.1.1.1|1022228` - `name` | This and/or any other search param, or `_id` | [`string`] | The start of either family or given name of the patient. Example: `Pete` - `family` | This and/or any other search param, or `_id` | [`string`] | The start of the family name of the patient. Example: `Adam` - `given` | This and/or any other search param, or `_id` | [`string`] | The start of the given name of the patient. Example: `Tim` - `birthdate` | This and/or any other search param, or `_id` | [`date`] | The patient's date of birth. Example: `1961-01-16` - `phone` | This and/or any other search param, or `_id` | [`token`] | The patient's phone number. Example: `1111111111` - `email` | This and/or any other search param, or `_id` | [`token`] | The patient's email address. Example: `example@example.com` - `address-postalcode` | This and/or any other search param, or `_id` | [`string`] | The postal code in the address details of the patient. Example: `11111` - `gender` | No | [`token`] | The gender of the patient. Example: `male` - [`_count`] | No | [`number`] | The maximum number of results to return. Defaults to `20`. - -Notes: - -* Either the `_id`, or a combination of `identifier` , `birthdate`, `name`, `given`, `family`, `address-postalcode`, `phone`, or `email` parameters must be provided. -* The `gender` parameter may only be provided if at least one of `identifier` , `birthdate`, `name`, `given`, `family`, `address-postalcode`, `phone`, or `email` parameters is provided. -* The `name`, `family`, and `given` parameters support the ':exact' modifier and will search for current names only. -* It is not recommended to combine `family` or `given` parameters with `name` parameter when searching for a patient. Whenever possible use the ':exact' modifier. -* The `address-postalcode` parameter supports the `:exact` modifer. +| Name | Required? | Type | Description | +|----------------------|---------------|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `_id` | Conditionally | [`token`] | The logical resource ID associated with the resource. This parameter is required if at least one of the following parameters is not used: `identifier`, `name`, `family`, `given`, `birthdate`, `phone`, `email`, or `address-postalcode`. Example: `11111111` | +| `identifier` | Conditionally | [`token`] | A patient identifier. This parameter is required if `_id`, `name`, `family`, `given`, `birthdate`, `phone`, `email`, and `address-postalcode` are not used. Example: `urn:oid:1.1.1.1.1.1\|1022228` | +| `name` | Conditionally | [`string`] | The start of the family or given name of the patient. This parameter is required if `_id`, `identifier`, `family`, `given`, `birthdate`, `phone`, `email`, and `address-postalcode` are not used. Example: `Pete` | +| `family` | Conditionally | [`string`] | The start of the family name of the patient. This parameter is required if `_id`, `identifier`, `name`, `given`, `birthdate`, `phone`, `email`, and `address-postalcode` are not used. Example: `Adam` | +| `given` | Conditionally | [`string`] | The start of the given name of the patient. This parameter is required if `_id`, `identifier`, `name`, `family`, `birthdate`, `phone`, `email`, and `address-postalcode` are not used. Example: `Tim` | +| `birthdate` | Conditionally | [`date`] | The patient's date of birth. This parameter is required if `_id`, `identifier`, `name`, `family`, `given`, `phone`, `email`, and `address-postalcode` are not used. Example: `1961-01-16` | +| `phone` | Conditionally | [`token`] | The patient's phone number. This parameter is required if `_id`, `identifier`, `name`, `family`, `given`, `birthdate`, `email`, and `address-postalcode` are not used. Example: `1111111111` | +| `email` | Conditionally | [`token`] | The patient's email address. This parameter is required if `_id`, `identifier`, `name`, `family`, `given`, `birthdate`, `phone`, and `address-postalcode` are not used. Example: `example@example.com` | +| `address-postalcode` | Conditionally | [`string`] | The postal code in the address details of the patient. This parameter is required if `_id`, `identifier`, `name`, `family`, `given`, `birthdate`, `phone`, and `email` are not used. Example: `11111` | +| `gender` | No | [`token`] | The administrative gender of the patient. Example: `male` | +| [`_count`] | No | [`number`] | The maximum number of results to return. Defaults to `20`. | + +_Notes_ + +* The `name`, `family`, and `given` parameters support the [`:exact`] modifier and search for current names only, based on the name's `period`. +* We do not recommend combining `family` or `given` parameters with the `name` parameter when searching for a patient. Whenever possible, use the `:exact` modifier. +* The `address-postalcode` parameter supports the [`:exact`] modifier. * The `identifier`, `name`, `family`, `given`, `phone`, `email`, `address-postalcode`, or `gender` parameters may be provided exactly once and may have only a single value. -* The `birthdate` parameter may be provided twice to indicate a date range, but must contain the inclusive prefixes 'le' and 'ge' -* The `birthdate` parameter may be provided once with the following prefixes: 'ge', 'le', 'gt', 'lt', 'eq' +* The `birthdate` parameter may be provided in the following formats: + * Once with a prefix of `ge`, `le`, `gt`, `lt`, or `eq`. Example: `birthdate=ge2001-03-13` + * Twice to indicate a date range and must contain one prefix each of `le` and `ge`. Example: `birthdate=ge2001-03-13&birthdate=le2001-05-01` +* A `422 - Unprocessable Entity` is returned when over 1,000 patients qualify for the search criteria. ### Headers @@ -98,22 +104,16 @@ Notes: <%= headers status: 200 %> <%= json(:dstu2_patient_bundle) %> -<%= disclaimer %> +## Retrieve by ID -### Errors - -The common [errors] and [OperationOutcomes] may be returned. In addition, a `422 Unprocessable Entity` will be returned when too many (>1000) patients qualify for the search criteria. - -## Retrieve by id - -List an individual Patient by its id: +List an individual patient by their ID. GET /Patient/:id -_Implementation Notes_ +_Notes_ -* The [Patient.animal] modifier element is not supported and will not be returned. -* Direct secure email will not be returned. +* The [Patient.animal] modifier element is not supported and not returned. +* Direct secure email is not returned. ### Authorization Types @@ -134,16 +134,12 @@ _Implementation Notes_ <%= headers status: 200 %> <%= json(:dstu2_patient_entry) %> -<%= disclaimer %> - -### Patient Combines Example +### Patient Combine Example -Cerner Millennium supports the ability to logically merge a patient record into another patient record when both records are describing the same patient. This is known -as a "patient combine". If necessary, this merging can later be undone by performing a "patient uncombine". When the requested patient record has been combined into another -record, an inactive Patient entry will be returned which has a link to the current Patient entry. Entries for combined patients will only be returned when retrieving -the entries directly by id. They will not be returned when searching with other parameters. - -The ability to perform patient combine or uncombine operations is not available through the Cerner Ignite platform. +Millennium supports the ability to logically merge a patient record into another patient record when both records are describing the same patient. This action is known +as a patient combine. If necessary, a patient uncombine can undo this merging. When the requested patient record is combined into another +record, an inactive patient entry is returned with a link to the current patient entry. Entries for combined patients are only returned when retrieving +the entries directly by ID. They are not returned when searching with other parameters. #### Request @@ -154,21 +150,15 @@ The ability to perform patient combine or uncombine operations is not available <%= headers status: 200 %> <%= json(:dstu2_combined_patient_entry) %> -<%= disclaimer %> - -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - ## Create -Create an individual Patient: +Create an individual patient. POST /Patient -_Implementation Notes_ +_Notes_ -* The following elements are not supported and will cause an error to be returned if set: +* The following elements are not supported and return an error if set: * [Patient.deceased] * [Patient.multipleBirth] * [Patient.photo] @@ -187,7 +177,7 @@ _Implementation Notes_ ### Body Fields -Notes: +_Notes_ * Birth Sex may be recorded as an extension. @@ -213,7 +203,8 @@ Vary: Origin,User-Agent,Accept-Encoding Strict-Transport-Security: max-age=631152000 X-Xss-Protection: 1; mode=block Pragma: no-cache -X-Request-Id: 78a19072002b8651623351cfedaffe70 +X-Request-Id: f17bbd99-f89b-4cfe-8425-43b14e5735cf +opc-request-id: /5E94C5FFC27CDD51DB70C0F464E44A96/AECA8B137DC613A323E70B1ED7C53808 Etag: W/"0" X-Frame-Options: SAMEORIGIN X-Content-Type-Options: nosniff @@ -226,28 +217,23 @@ Content-Type: application/json 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. - -[Time of day of birth]: http://hl7.org/fhir/DSTU2/extension-patient-birthtime.html -[Argonaut Race]: http://build.fhir.org/ig/Healthedata1/Argo-DSTU2/StructureDefinition-argo-race.html -[Argonaut Ethnicity]: http://build.fhir.org/ig/Healthedata1/Argo-DSTU2/StructureDefinition-argo-ethnicity.html -[Argonaut Patient Birth Sex]: http://build.fhir.org/ig/Healthedata1/Argo-DSTU2/StructureDefinition-argo-birthsex.html -[Rendered Value]: http://hl7.org/fhir/extension-rendered-value.html -[`token`]: http://hl7.org/fhir/DSTU2/search.html#token -[`date`]: http://hl7.org/fhir/DSTU2/search.html#date -[`string`]: http://hl7.org/fhir/DSTU2/search.html#string -[`_count`]: http://hl7.org/fhir/DSTU2/search.html#count -[`number`]: http://hl7.org/fhir/DSTU2/search.html#number -[Patient.deceased]: http://hl7.org/fhir/dstu2/patient-definitions.html#Patient.deceased_x_ -[Patient.multipleBirth]: http://hl7.org/fhir/dstu2/patient-definitions.html#Patient.multipleBirth_x_ -[Patient.photo]: http://hl7.org/fhir/dstu2/patient-definitions.html#Patient.photo -[Patient.contact]: http://hl7.org/fhir/dstu2/patient-definitions.html#Patient.contact -[Patient.animal]: http://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.animal -[Patient.managingOrganization]: http://hl7.org/fhir/dstu2/patient-definitions.html#Patient.managingOrganization -[Patient.link]: http://hl7.org/fhir/dstu2/patient-definitions.html#Patient.link +[Time of day of birth]: https://hl7.org/fhir/DSTU2/extension-patient-birthtime.html +[Argonaut Race]: https://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-race.html +[Argonaut Ethnicity]: https://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-ethnicity.html +[Argonaut Patient Birth Sex]: https://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-birthsex.html +[Rendered Value]: https://www.hl7.org/fhir/DSTU2/extensibility.html +[`token`]: https://hl7.org/fhir/DSTU2/search.html#token +[`date`]: https://hl7.org/fhir/DSTU2/search.html#date +[`string`]: https://hl7.org/fhir/DSTU2/search.html#string +[`_count`]: https://hl7.org/fhir/DSTU2/search.html#count +[`number`]: https://hl7.org/fhir/DSTU2/search.html#number +[`:exact`]: https://hl7.org/fhir/R4/search.html#string +[Patient.deceased]: https://hl7.org/fhir/dstu2/patient-definitions.html#Patient.deceased_x_ +[Patient.multipleBirth]: https://hl7.org/fhir/dstu2/patient-definitions.html#Patient.multipleBirth_x_ +[Patient.photo]: https://hl7.org/fhir/dstu2/patient-definitions.html#Patient.photo +[Patient.contact]: https://hl7.org/fhir/dstu2/patient-definitions.html#Patient.contact +[Patient.animal]: https://hl7.org/fhir/DSTU2/patient-definitions.html#Patient.animal +[Patient.managingOrganization]: https://hl7.org/fhir/dstu2/patient-definitions.html#Patient.managingOrganization +[Patient.link]: https://hl7.org/fhir/dstu2/patient-definitions.html#Patient.link [errors]: ../../#client-errors [OperationOutcomes]: ../../#operation-outcomes diff --git a/content/millennium/dstu2/individuals/practitioner.md b/content/millennium/dstu2/individuals/practitioner.md index 2348aaf5f..aa787fb8d 100644 --- a/content/millennium/dstu2/individuals/practitioner.md +++ b/content/millennium/dstu2/individuals/practitioner.md @@ -9,17 +9,23 @@ title: Practitioner | DSTU 2 API ## Overview -The Practitioner resource provides information about a person formally involved in the care of a patient on behalf of a healthcare facility. Practitioners include and are not limited to physicians, nurses, pharmacists, therapists, technologists, and social workers. +The Practitioner resource provides information about a person formally involved in the care of a patient on behalf of a healthcare facility. Practitioners include but are not limited to physicians, nurses, pharmacists, therapists, technologists, and social workers. The following fields are returned if valued: - * [Practitioner id](http://hl7.org/fhir/DSTU2/resource-definitions.html#Resource.id){:target="_blank"} - * [Identifiers/Aliases such as NPI and DEA](http://hl7.org/fhir/DSTU2/practitioner-definitions.html#Practitioner.identifier){:target="_blank"} - * [Active](http://hl7.org/fhir/DSTU2/practitioner-definitions.html#Practitioner.active){:target="_blank"} - * [Name](http://hl7.org/fhir/DSTU2/practitioner-definitions.html#Practitioner.name){:target="_blank"} - * [Contact (secure email and phone)](http://hl7.org/fhir/DSTU2/practitioner-definitions.html#Practitioner.telecom){:target="_blank"} - * [Address](http://hl7.org/fhir/DSTU2/practitioner-definitions.html#Practitioner.address){:target="_blank"} - * [Gender](http://hl7.org/fhir/DSTU2/practitioner-definitions.html#Practitioner.gender){:target="_blank"} + * [Practitioner ID](https://hl7.org/fhir/DSTU2/resource-definitions.html#Resource.id){:target="_blank"} + * [Identifier](https://hl7.org/fhir/DSTU2/practitioner-definitions.html#Practitioner.identifier){:target="_blank"} + * [Active](https://hl7.org/fhir/DSTU2/practitioner-definitions.html#Practitioner.active){:target="_blank"} + * [Name](https://hl7.org/fhir/DSTU2/practitioner-definitions.html#Practitioner.name){:target="_blank"} + * [Contact](https://hl7.org/fhir/DSTU2/practitioner-definitions.html#Practitioner.telecom){:target="_blank"} + * [Address](https://hl7.org/fhir/DSTU2/practitioner-definitions.html#Practitioner.address){:target="_blank"} + * [Gender](https://hl7.org/fhir/DSTU2/practitioner-definitions.html#Practitioner.gender){:target="_blank"} + +<%= disclaimer %> + +### Errors + +The common [errors] and [OperationOutcomes] may be returned. ## Terminology Bindings @@ -27,7 +33,7 @@ The following fields are returned if valued: ## Search -Search for Practitioners that meet supplied query parameters: +Search for practitioners that meet supplied query parameters. GET /Practitioner?:parameters @@ -39,7 +45,7 @@ Search for Practitioners that meet supplied query parameters: Name | Required? | Type | Description -------|-----------|-----------|------------------------------------------------------- - `_id` | Yes | [`token`] | The logical resource id associated with the resource. + `_id` | Yes | [`token`] | The logical resource ID associated with the resource. ### Headers @@ -55,15 +61,9 @@ Search for Practitioners that meet supplied query parameters: <%= headers status: 200 %> <%= json(:dstu2_practitioner_bundle) %> -<%= disclaimer %> - -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - -## Retrieve by id +## Retrieve by ID -List an individual Practitioner by its id: +List an individual practitioner by their ID. GET /Practitioner/:id @@ -85,12 +85,6 @@ List an individual Practitioner by its id: <%= headers status: 200 %> <%= json(:dstu2_practitioner_entry) %> -<%= disclaimer %> - -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - [`token`]: http://hl7.org/fhir/DSTU2/search.html#token [errors]: ../../#client-errors [OperationOutcomes]: ../../#operation-outcomes diff --git a/content/millennium/dstu2/medications/medication-order.md b/content/millennium/dstu2/medications/medication-order.md index 22583ca8d..ea446850c 100644 --- a/content/millennium/dstu2/medications/medication-order.md +++ b/content/millennium/dstu2/medications/medication-order.md @@ -9,32 +9,38 @@ title: MedicationOrder | DSTU 2 API ## Overview -The Medication Order resource provides orders for all medications along with administration instructions for a patient in both the inpatient and outpatient setting (orders/prescriptions filled by a pharmacy and discharge medication orders). This resource does NOT include historical or home medications documented or reported to have been taken by patient, significant other or another provider. +The MedicationOrder resource provides orders for all medications with administration instructions for a patient in both the inpatient and outpatient settings (orders or prescriptions filled by a pharmacy and discharge medication orders). This resource does not include historical or home medications documented or reported to have been taken by the patient, significant other, or another provider. -If the Medication Order represents a prescription (something the patient takes at home), the start, stop, and other data may not be a representation of when the medication was taken. For example, the system may not know if the patient ever filled or took the prescribed medication, or when the prescription was filled. +If the medication order represents a prescription the patient takes at home, then the start, stop, and other information may not be a representation of when the medication was taken. For example, the system may not know if the patient ever filled or took the prescribed medication, or when the prescription was filled. The following fields are returned if valued: -* [Medication order id](http://hl7.org/fhir/dstu2/resource-definitions.html#Resource.id){:target="_blank"} -* [Date/Time order written](http://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.dateWritten){:target="_blank"} -* [Status](http://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.status){:target="_blank"} -* [Date/Time order stopped or to stop](http://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.dateEnded){:target="_blank"} -* [Patient](http://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.patient){:target="_blank"} -* [Prescriber](http://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.prescriber){:target="_blank"} -* [Patient encounter](http://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.encounter){:target="_blank"} -* [Medication](http://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.medication_x_){:target="_blank"} +* [Medication order ID](https://hl7.org/fhir/dstu2/resource-definitions.html#Resource.id){:target="_blank"} +* [Date/Time order written](https://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.dateWritten){:target="_blank"} +* [Status](https://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.status){:target="_blank"} +* [Date/Time order stopped or to stop](https://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.dateEnded){:target="_blank"} +* [Patient](https://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.patient){:target="_blank"} +* [Prescriber](http:s//hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.prescriber){:target="_blank"} +* [Patient encounter](https://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.encounter){:target="_blank"} +* [Medication](https://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.medication_x_){:target="_blank"} * Details of medication taken: - * [Dosage Instructions:](http://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.dosageInstruction){:target="_blank"} + * [Dosage Instructions:](https://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.dosageInstruction){:target="_blank"} * [Patient friendly dosage display](#custom-extensions){:target="_blank"} - * [Additional instructions](http://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.dosageInstruction.additionalInstructions){:target="_blank"} - * [Time period and frequency](http://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.dosageInstruction.timing){:target="_blank"} - * [As needed (such as PRN for pain)](http://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.dosageInstruction.asNeeded_x_){:target="_blank"} - * [Route](http://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.dosageInstruction.route){:target="_blank"} - * [Dosage](http://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.dosageInstruction.dose_x_){:target="_blank"} + * [Additional instructions](https://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.dosageInstruction.additionalInstructions){:target="_blank"} + * [Time period and frequency](https://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.dosageInstruction.timing){:target="_blank"} + * [As needed (such as PRN for pain)](https://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.dosageInstruction.asNeeded_x_){:target="_blank"} + * [Route](https://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.dosageInstruction.route){:target="_blank"} + * [Dosage](https://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.dosageInstruction.dose_x_){:target="_blank"} * Dispensing details: - * [Validity period](http://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.dispenseRequest.validityPeriod){:target="_blank"} - * [Number of refills](http://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.dispenseRequest.numberOfRepeatsAllowed){:target="_blank"} - * [Amount of medication to supply/dispense](http://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.dispenseRequest.quantity){:target="_blank"} + * [Validity period](https://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.dispenseRequest.validityPeriod){:target="_blank"} + * [Number of refills](https://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.dispenseRequest.numberOfRepeatsAllowed){:target="_blank"} + * [Amount of medication to supply/dispense](https://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.dispenseRequest.quantity){:target="_blank"} + +<%= disclaimer %> + +### Errors + +The common [errors] and [OperationOutcomes] may be returned. ## Terminology Bindings @@ -52,43 +58,52 @@ The following fields are returned if valued: All URLs for custom extensions are defined as `https://fhir-ehr.cerner.com/dstu2/StructureDefinition/{id}` +For more information, see the StructureDefinition resource. + 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 name that can be used for this field when producing a view suitable for a patient. ## Search -Search for MedicationOrders that meet supplied query parameters: +Search for medication orders that meet supplied query parameters. GET /MedicationOrder?:parameters -_Implementation Notes_ - -* MedicationOrder may have 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 MedicationOrder and cannot be be referenced independently. - ### Authorization Types <%= authorization_types(provider: true, patient: true, system: true) %> ### Parameters - Name | Required? | Type | Description -------------------------|-----------|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- - `_id` | Y or `patient` | [`token`] | The logical resource id associated with the resource. - `patient` | Y or `_id` | [`reference`] | The identity of a patient to list orders for. Example: `12345` - `status` | N | [`token`] | The status of the medication order, may be a list separated by commas. Example: `active,draft` - `-timing-boundsPeriod` | N | [`date`] | The date-time which should fall within the [period] the medication should be given to the patient. Must be prefixed by 'ge'. Example: `ge2014-05-19T20:54:02.000Z` - `_lastUpdated` | N | [`date`] | An explicit or implied date-time range within which the most recent clinically relevant update was made to the medication. Must be prefixed by 'ge' or 'le'. Example: `ge2014-05-19T20:54:02.000Z` - [`_count`] | N | [`number`] | The maximum number of results to include in a page. Example: `50` - -Notes: - -* The `-timing-boundsPeriod` and `_lastUpdated` parameters may not be provided at the same time. - -* The `_lastUpdated` parameter must have a time, may be provided up to two times, and must use the `ge` or `le` prefixes. When provided twice, the lower value must have the `ge` prefix and the higher value must have the `le` prefix. - -* Searching with the `_lastUpdated` parameter will only detect changes to fields that affect the clinical meaning of the order. An example of the types of changes that won't be caught by this query are changes that would affect the version, but not the FHIR content. + 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 orders for. This parameter is required if the `_id` parameter is not used. Example: `patient=5678` + `status` | No | [`token`] | The [status] of the medication order. It may be a list separated by commas. Example: `status=active,draft` + `-timing-boundsPeriod` | No | [`date`] | The date and time that should fall within the [period] when the medication should be given to the patient. This parameter cannot be provided at the same time as the `_lastUpdated` parameter. Example: `-timing-boundsPeriod=ge2014-05-19T20:54:02.000Z` + `_lastUpdated` | No | [`date`] | An explicit or implied date and time range within which the most recent clinically relevant update was made to the medication. This parameter cannot be provided at the same time as the `-timing-boundsPeriod` parameter. Example: `_lastUpdated=ge2014-05-19T20:54:02.000Z` + [`_count`] | No | [`number`] | The maximum number of results to include on a page. Example: `_count=50` + +_Notes_ + +* MedicationOrder.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 order and cannot be referenced independently. +* When searching with the `_id` parameter: + * It must not be provided with any other parameters. +* When searching with the `-timing-boundsPeriod` parameter: + * It must be provided with a `ge` prefix to imply the date range for the medication orders search. + * The time component is optional. + * Example: `-timing-boundsPeriod=ge2014-05-19T20:54:02.000Z` +* When searching with the `_lastUpdated` parameter: + * The time component is required. + * For a single `_lastUpdated` occurence: + * It must be provided with a `le` or `ge` prefix to imply the date range for the medication orders search. + * Example: `_lastUpdated=ge2014-05-19T20:54:02.000Z` + * For two `_lastUpdated` occurences: + * It must be provided with the `le` and `ge` prefixes to search for medication orders within the given upper and lower timestamps, respectively. + * Example: `_lastUpdated=ge2014-05-19T20:54:02.000Z&_lastUpdated=le2014-05-20T12:00:00.000Z` + * It only detects changes that affect the clinical meaning of the order. An example of changes that are not caught by this query are changes that would affect the version, but not the FHIR content. ### Headers @@ -105,15 +120,9 @@ Notes: <%= headers status: 200 %> <%= json(:dstu2_medication_order_bundle) %> -<%= disclaimer %> - -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - -## Retrieve by id +## Retrieve by ID -List an individual MedicationOrder by its id: +List an individual medication order by its ID. GET /MedicationOrder/:id @@ -136,20 +145,16 @@ List an individual MedicationOrder by its id: <%= headers status: 200 %> <%= json(:dstu2_medication_order_entry) %> -<%= disclaimer %> - -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - -[`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 -[period]: http://hl7.org/fhir/DSTU2/MedicationOrder-definitions.html#MedicationOrder.dosageInstruction.timing -[`_count`]: http://hl7.org/fhir/dstu2/search.html#count -[`number`]: http://hl7.org/fhir/dstu2/search.html#number -[contained]: http://hl7.org/fhir/DSTU2/references.html#contained +[`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 +[period]: https://hl7.org/fhir/DSTU2/MedicationOrder-definitions.html#MedicationOrder.dosageInstruction.timing +[`_count`]: https://hl7.org/fhir/dstu2/search.html#count +[`number`]: https://hl7.org/fhir/dstu2/search.html#number +[contained]: https://hl7.org/fhir/DSTU2/references.html#contained [Patient friendly display]: #custom-extensions -[`string`]: http://hl7.org/fhir/DSTU2/datatypes.html#string +[`string`]: https://hl7.org/fhir/DSTU2/datatypes.html#string [errors]: ../../#client-errors [OperationOutcomes]: ../../#operation-outcomes +[CodeableConcept]: https://hl7.org/fhir/DSTU2/datatypes.html#codeableconcept +[status]: https://www.hl7.org/fhir/dstu2/valueset-medication-order-status.html diff --git a/content/millennium/dstu2/medications/medication-statement.md b/content/millennium/dstu2/medications/medication-statement.md index 848a0a764..ff929ac4e 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, which were reported by 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. +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: -* [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 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 %> + +### Errors + +The common [errors] and [OperationOutcomes] may be returned. ## Terminology Bindings @@ -65,21 +71,16 @@ 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. - `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 -_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. 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`. -Notes: +_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 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. ### Headers @@ -115,23 +119,12 @@ Notes: <%= headers status: 200 %> <%= json(:dstu2_medication_statement_bundle) %> -<%= disclaimer %> +## Retrieve by ID -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - -## Retrieve by id - -List an individual MedicationStatement by its id: +List an individual medication statement 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 medication statement. POST /MedicationStatement -_Implementation Notes_ +_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 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 @@ -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 medication statement. PUT /MedicationStatement/:id -_Implementation Notes_ +_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 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 returns 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/content/millennium/r4/base/individuals/person.md b/content/millennium/r4/base/individuals/person.md index 2323e9be7..20df3c627 100644 --- a/content/millennium/r4/base/individuals/person.md +++ b/content/millennium/r4/base/individuals/person.md @@ -9,12 +9,12 @@ title: Person | R4 API ## Overview -The Person resource identifies an individual outside of a specific health care context providing a mechanism to link person resources across different facilities or organizations. +The Person resource identifies an individual outside of a specific healthcare context and provides a mechanism to associate person resources across different facilities or organizations. The following fields are returned if valued: -* [Person id](https://hl7.org/fhir/r4/resource-definitions.html#Resource.id){:target="_blank"} -* [Identifier (Cerner alias Federated Person Principal)](https://hl7.org/fhir/R4/person-definitions.html#Person.identifier){:target="_blank"} +* [Person ID](https://hl7.org/fhir/r4/resource-definitions.html#Resource.id){:target="_blank"} +* [Identifier](https://hl7.org/fhir/R4/person-definitions.html#Person.identifier){:target="_blank"} * [Name](https://hl7.org/fhir/R4/person-definitions.html#Person.name){:target="_blank"} * [Telecom](https://hl7.org/fhir/R4/person-definitions.html#Person.telecom){:target="_blank"} * [Gender](https://hl7.org/fhir/R4/person-definitions.html#Person.gender){:target="_blank"} @@ -22,13 +22,19 @@ The following fields are returned if valued: * [Address](https://hl7.org/fhir/R4/person-definitions.html#Person.address){:target="_blank"} * [Active](https://hl7.org/fhir/R4/person-definitions.html#Person.active){:target="_blank"} +<%= disclaimer %> + +### Errors + +The common [errors] and [OperationOutcomes] may be returned. + ## Terminology Bindings <%= terminology_table(:person, :r4) %> ## Search -Search for Persons that meet supplied query parameters: +Search for persons that meet supplied query parameters. GET /Person?:parameters @@ -38,10 +44,10 @@ Search for Persons that meet supplied query parameters: ### Parameters - Name | Required? | Type | Description ---------------|----------------------------------------------|-----------|------------------------------------------------------------------------------ - `_id` | This, or any other required search parameter | [`token`] | The logical resource id associated with the resource. - `identifier` | This or `_id` | [`token`] | The person identifier. Example: `urn:oid:2.16.840.1.113883.3.13.6|01022228` + Name | Required | Type | Description +--------------|---------------|-----------|------------------------------------------------------------------------------ + `_id` | Conditionally | [`token`] | The logical resource ID associated with the resource. This parameter is required if the `identifier` parameter is not used. + `identifier` | Conditionally | [`token`] | The person identifier. This parameter is required if the `_id` parameter is not used. Notes: @@ -55,22 +61,16 @@ Notes: #### Request - GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Person?_id=12724067 + GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Person?identifier=urn:oid:2.16.840.1.113883.6.1000|31577 #### Response <%= headers status: 200 %> <%= json(:r4_person_bundle) %> -<%= disclaimer %> - -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - -## Retrieve by id +## Retrieve by ID -List an individual Person by its id: +List an individual person by their ID. GET /Person/:id @@ -95,13 +95,9 @@ List an individual Person by its id: <%= disclaimer %> -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - ### Person Combines Example -Cerner Millennium supports the ability to logically merge a person record into another person record when both records are describing the same person. This is known as a “person combine”. If necessary, this merging can later be undone by performing a “person uncombine”. When the requested person record has been combined into another record, an inactive Person entry will be returned which has a link to the current Person entry. Entries for combined patients will only be returned when retrieving the entries directly by id. They will not be returned when searching with other parameters. The ability to perform person combine or uncombine operations is not available through the Cerner Ignite platform. +Oracle Health Millennium Platform supports the ability to logically merge a person record into another person record when both records are describing the same person. This merge is known as a person combine. If necessary, you can perform a person uncombine to undo the merge. When the requested person record is combined into another record, an inactive person entry is returned with a link to the current person entry. Entries for combined patients are only returned when retrieving the entries directly by ID. They are not returned when searching with other parameters. #### Request @@ -112,12 +108,6 @@ Cerner Millennium supports the ability to logically merge a person record into a <%= headers status: 200 %> <%= json(:r4_combined_person_entry) %> -<%= disclaimer %> - -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - [`token`]: http://hl7.org/fhir/R4/search.html#token [errors]: ../../../#client-errors [OperationOutcomes]: ../../../#operation-outcomes diff --git a/content/millennium/r4/base/individuals/practitioner.md b/content/millennium/r4/base/individuals/practitioner.md index e4718eaaa..e5fe101d3 100644 --- a/content/millennium/r4/base/individuals/practitioner.md +++ b/content/millennium/r4/base/individuals/practitioner.md @@ -9,45 +9,47 @@ title: Practitioner | R4 API ## Overview -The Practitioner Resource provides information about a person formally involved in the care of a patient on behalf of a healthcare facility. Practitioners include but are not limited to physicians, nurses, pharmacists, therapists, technologists, and social workers. +The Practitioner resource provides information about a person formally involved in the care of a patient on behalf of a healthcare facility. Practitioners include but are not limited to physicians, nurses, pharmacists, therapists, technologists, and social workers. -Not all practitioners have access to the EHR but can be referenced by other resources to indicate they are in some way involved in a patient's care. +Not all practitioners have access to the electronic health record (EHR) but can be referenced by other resources to indicate that they are in some way involved in a patient's care. -* The following [HL7® FHIR® US Core Implementation Guide STU 4.0.0](https://hl7.org/fhir/us/core/STU4/){:target="_blank"} 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/){:target="_blank"} profiles: * [US Core Practitioner Profile](https://hl7.org/fhir/us/core/STU4/StructureDefinition-us-core-practitioner.html){:target="_blank"} The following fields are returned if valued: -* [Practitioner id](https://hl7.org/fhir/r4/resource-definitions.html#Resource.id){:target="_blank"} -* [Identifiers/Aliases such as NPI and DEA](https://hl7.org/fhir/r4/practitioner-definitions.html#Practitioner.identifier){:target="_blank"} -* [Active (true/false)](https://hl7.org/fhir/r4/practitioner-definitions.html#Practitioner.active){:target="_blank"} +* [Practitioner ID](https://hl7.org/fhir/r4/resource-definitions.html#Resource.id){:target="_blank"} +* [Identifier](https://hl7.org/fhir/r4/practitioner-definitions.html#Practitioner.identifier){:target="_blank"} +* [Active](https://hl7.org/fhir/r4/practitioner-definitions.html#Practitioner.active){:target="_blank"} * [Name](https://hl7.org/fhir/r4/practitioner-definitions.html#Practitioner.name){:target="_blank"} -* [Telecom Information (secure email and phone)](https://hl7.org/fhir/r4/practitioner-definitions.html#Practitioner.telecom){:target="_blank"} -* [Address (Provider and System Authorization Only)](https://hl7.org/fhir/r4/practitioner-definitions.html#Practitioner.address){:target="_blank"} +* [Telecom](https://hl7.org/fhir/r4/practitioner-definitions.html#Practitioner.telecom){:target="_blank"} +* [Address](https://hl7.org/fhir/r4/practitioner-definitions.html#Practitioner.address){:target="_blank"} * [Gender](https://hl7.org/fhir/r4/practitioner-definitions.html#Practitioner.gender){:target="_blank"} * [Qualification](https://hl7.org/fhir/r4/practitioner-definitions.html#Practitioner.qualification){:target="_blank"} * [Is Physician Extension](#extensions) -## Terminology Bindings +<%= disclaimer %> -<%= terminology_table(:practitioner, :r4) %> +### Errors + +The common [errors] and [OperationOutcomes] may be returned. -## Extensions +## Terminology Bindings -* [Is Physician] +<%= terminology_table(:practitioner, :r4) %> -### Custom Extensions +## Custom Extensions All URLs for custom extensions are defined as `https://fhir-ehr.cerner.com/r4/StructureDefinition/{id}` - ID | Value\[x] Type | Description ------------------------|----------------|------------------------------------------------------------------------------------------------ - `is-physician` | [`Boolean`](https://hl7.org/fhir/r4/datatypes.html#boolean) | Indication of whether the provider is a physician or not. +| ID | Value\[x] Type | Description | +|----------------|-------------------------------------------------------------|---------------------------------------------------------------| +| `is-physician` | [`boolean`] | Indicates whether the practitioner is a physician. | ## Search -Search for Practitioners that meet supplied query parameters: +Search for practitioners that meet supplied query parameters. GET /Practitioner?:parameters @@ -57,22 +59,23 @@ Search for Practitioners that meet supplied query parameters: ### Parameters - Name | Required? | Type | Description --------------|------------------------------------------------------------|------------|------------------------------------------------------------------------ - `_id` | This or any other required search parameter | [`token`] | The logical resource id associated with the resource. - `identifier`| This or any other required search parameter | [`token`] | A practitioner identifier/alias. Example: `http://hl7.org/fhir/sid/us-npi|4326587548` - `family` | This or any other required search parameter | [`string`] | The start of the family name of the practitioner. Example: `Smith` - `given` | This and `family`, or any other required search parameter | [`string`] | The start of the given name of the practitioner. Example: `John` - `name` | This or any other required search parameter | [`string`] | The start of the first, middle or last name of the practitioner. Example: `John` or `Smith` - `active` | This or any other required search parameter | [`token`] | true or false. Example: `active=true` - [`_count`] | No | [`number`] | Number of results per page. +| Name | Required? | Type | Description | +|--------------|---------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `_id` | Conditionally | [`token`] | The logical resource ID associated with the resource. This parameter is required if `identifier`, `family`, `name`, or `active` is not used. Example: `12345` | +| `identifier` | Conditionally | [`token`] | The practitioner identifier. This parameter is required if `_id`, `family`, `name`, or `active` is not used. | +| `family` | Conditionally | [`string`] | The start of the family name of the practitioner. This parameter is required if `_id`, `identifier`, `name`, or `active` is not used. Example: `Smith` | +| `name` | Conditionally | [`string`] | The start of the given name or the family name of the practitioner. This parameter is required if `_id`, `identifier`, `family,` or `active` is not used. Example: `Riley` | +| `active` | Conditionally | [`token`] | The indication of whether this practitioner's record is in active use. This parameter is required if `_id`, `identifier`, `family`, or `name` is not used. Example: `active=true` | +| `given` | No | [`string`] | The start of the given name of the practitioner. Example: `John` | +| [`_count`] | No | [`number`] | The number of results per page. | - Notes: +Notes: -* When provided, the `identifier` query parameter must include both a system and a code. -* The `given` parameter may only be provided if `family` parameter is provided. -* The `name` parameter must have at least 2 characters -* When provided, the `active` query parameter must not include system. It accepts only true or false code. +* The `identifier` query parameter must include both a system and a code. + * Example: `http://hl7.org/fhir/sid/us-npi|4326587548` +* If the `given` parameter is provided, the `family` parameter is required. +* The `name` parameter must have at least two characters. +* The `active` query parameter must not include a system, and the code must be `true` or `false`. Example: `active=false` ### Headers @@ -82,43 +85,16 @@ Search for Practitioners that meet supplied query parameters: #### Request - GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner?_id=109413936 + GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner?identifier=http%3A%2F%2Fhl7.org%2Ffhir%2Fsid%2Fus-npi%7C1111111111 #### Response <%= headers status: 200 %> <%= json(:r4_practitioner_bundle) %> -<%= disclaimer %> - -#### Request - - GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner?active=true - -#### Response - -<%= headers status: 200 %> -<%= json(:r4_practitioner_active_bundle) %> - -<%= disclaimer %> - -#### Patient Authorization Request - - GET https://fhir-myrecord.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner?_id=109413936 - -#### Response - -<%= headers status: 200 %> -<%= json(:r4_practitioner_patient_access_bundle) %> - -<%= disclaimer %> -### Errors - -The common [errors] and [OperationOutcomes] may be returned. +## Retrieve by ID -## Retrieve by id - -List an individual Practitioner by its id: +List an individual practitioner by their ID. GET /Practitioner/:id @@ -141,24 +117,9 @@ List an individual Practitioner by its id: <%= headers status: 200 %> <%= json(:r4_practitioner_entry) %> -<%= disclaimer %> -#### Patient Authorization Request - - GET https://fhir-myrecord.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner/109413936 - -#### Response - -<%= headers status: 200 %> -<%= json(:r4_practitioner_patient_access_entry) %> - -<%= disclaimer %> -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - ## Create -Create an individual Practitioner that can be referenced by other resources. This API is not used for user provisioning. +Create an individual practitioner that can be referenced by other resources. This API is not used for user provisioning. POST /Practitioner @@ -197,16 +158,13 @@ Last-Modified: Mon, 09 Dec 2019 18:57:39 GMT Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner/7118008 Vary: Origin X-Request-Id: 9d3aecfa-c846-4ce2-825a-7ba2fce4813f +opc-request-id: /D14ABE620D8D0DBB4D5970966EED037B/6A781B5941C550741C19E1AE1E795C33 -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - -[`token`]: http://hl7.org/fhir/r4/search.html#token +[`token`]: https://hl7.org/fhir/r4/search.html#token [`string`]: https://hl7.org/fhir/R4/search.html#string -[`_count`]: http://hl7.org/fhir/r4/search.html#count -[`number`]: http://hl7.org/fhir/r4/search.html#number +[`boolean`]: https://hl7.org/fhir/r4/datatypes.html#boolean +[`_count`]: https://hl7.org/fhir/r4/search.html#count +[`number`]: https://hl7.org/fhir/r4/search.html#number [errors]: ../../../#client-errors [OperationOutcomes]: ../../../#operation-outcomes -[Is Physician]: #custom-extensions diff --git a/content/millennium/r4/clinical/care-provision/goal.md b/content/millennium/r4/clinical/care-provision/goal.md index 065ea4745..57f9b7e0c 100644 --- a/content/millennium/r4/clinical/care-provision/goal.md +++ b/content/millennium/r4/clinical/care-provision/goal.md @@ -9,31 +9,37 @@ title: Goal | R4 API ## Overview -The Goal resource describes intended objectives for a patient. A Goal is typically expressed as a desired outcome or health state to be achieved by a patient over a period or at a specific point in time. A Goal may address preventative health or mitigation of a diagnosis or problem. Goals can be non-health care related (e.g. dance at a wedding). +The Goal resource describes intended objectives for a patient. A goal is typically expressed as a desired outcome or health state to be achieved by a patient over a period or at a specific point in time. A goal may address preventative health or mitigation of a diagnosis or problem. Goals can be non-healthcare related (for example, dance at a wedding). -* 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 Goal Profile](http://hl7.org/fhir/us/core/STU4/StructureDefinition-us-core-goal.html) + * [US Core Goal Profile](https://hl7.org/fhir/us/core/STU4/StructureDefinition-us-core-goal.html) The following fields are returned if valued: -* [Goal id](http://hl7.org/fhir/r4/resource-definitions.html#Resource.id){:target="_blank"} -* [Lifecycle Status](http://hl7.org/fhir/r4/goal-definitions.html#Goal.lifecycleStatus){:target="_blank"} -* [Achievement Status](http://hl7.org/fhir/r4/goal-definitions.html#Goal.achievementStatus){:target="_blank"} -* [Category](http://hl7.org/fhir/r4/goal-definitions.html#Goal.category){:target="_blank"} -* [Description](http://hl7.org/fhir/r4/goal-definitions.html#Goal.description){:target="_blank"} -* [Subject (patient)](http://hl7.org/fhir/r4/goal-definitions.html#Goal.subject){:target="_blank"} -* [Start Date](http://hl7.org/fhir/r4/goal-definitions.html#Goal.start_x_){:target="_blank"} -* [Target Due (Date only)](http://hl7.org/fhir/r4/goal-definitions.html#Goal.target.due_x_){:target="_blank"} -* [Status Date](http://hl7.org/fhir/r4/goal-definitions.html#Goal.statusDate){:target="_blank"} -* [Expressed By](http://hl7.org/fhir/r4/goal-definitions.html#Goal.expressedBy){:target="_blank"} - * [Reference](http://hl7.org/fhir/r4/references.html#Reference){:target="_blank"} ([Patient](http://hl7.org/fhir/r4/patient.html){:target="_blank"} \| [Practitioner](http://hl7.org/fhir/r4/practitioner.html){:target="_blank"} \| [Related Person](http://hl7.org/fhir/r4/relatedperson.html){:target="_blank"}) +* [Goal ID](https://hl7.org/fhir/r4/resource-definitions.html#Resource.id){:target="_blank"} +* [Lifecycle Status](https://hl7.org/fhir/r4/goal-definitions.html#Goal.lifecycleStatus){:target="_blank"} +* [Achievement Status](https://hl7.org/fhir/r4/goal-definitions.html#Goal.achievementStatus){:target="_blank"} +* [Category](https://hl7.org/fhir/r4/goal-definitions.html#Goal.category){:target="_blank"} +* [Description](https://hl7.org/fhir/r4/goal-definitions.html#Goal.description){:target="_blank"} +* [Subject (patient)](https://hl7.org/fhir/r4/goal-definitions.html#Goal.subject){:target="_blank"} +* [Start Date](https://hl7.org/fhir/r4/goal-definitions.html#Goal.start_x_){:target="_blank"} +* [Target Due](https://hl7.org/fhir/r4/goal-definitions.html#Goal.target.due_x_){:target="_blank"} +* [Status Date](https://hl7.org/fhir/r4/goal-definitions.html#Goal.statusDate){:target="_blank"} +* [Expressed By](https://hl7.org/fhir/r4/goal-definitions.html#Goal.expressedBy){:target="_blank"} + * [Reference](https://hl7.org/fhir/r4/references.html#Reference){:target="_blank"} ([Patient](https://hl7.org/fhir/r4/patient.html){:target="_blank"} \| [Practitioner](https://hl7.org/fhir/r4/practitioner.html){:target="_blank"} \| [Related Person](https://hl7.org/fhir/r4/relatedperson.html){:target="_blank"}) * [Addresses](https://hl7.org/fhir/r4/goal-definitions.html#Goal.addresses){:target="_blank"} - * [Reference](http://hl7.org/fhir/r4/references.html#Reference){:target="_blank"} ([Condition](https://hl7.org/fhir/r4/condition-definitions.html){:target="_blank"}) -* [Note](http://hl7.org/fhir/r4/goal-definitions.html#Goal.note){:target="_blank"} - * [Author Reference](http://hl7.org/fhir/r4/goal-definitions.html#Goal.note){:target="_blank"} - * [Text](http://hl7.org/fhir/r4/datatypes-definitions.html#Annotation.text){:target="_blank"} - * [Time](http://hl7.org/fhir/r4/datatypes-definitions.html#Annotation.time){:target="_blank"} + * [Reference](https://hl7.org/fhir/r4/references.html#Reference){:target="_blank"} ([Condition](https://hl7.org/fhir/r4/condition-definitions.html){:target="_blank"}) +* [Note](https://hl7.org/fhir/r4/goal-definitions.html#Goal.note){:target="_blank"} + * [Author Reference](https://hl7.org/fhir/r4/goal-definitions.html#Goal.note){:target="_blank"} + * [Text](https://hl7.org/fhir/r4/datatypes-definitions.html#Annotation.text){:target="_blank"} + * [Time](https://hl7.org/fhir/r4/datatypes-definitions.html#Annotation.time){:target="_blank"} + +<%= disclaimer %> + +### Errors + +The common [errors] and [OperationOutcomes] may be returned. ## Terminology Bindings @@ -41,7 +47,7 @@ The following fields are returned if valued: ## Search -Search for Goals that meet supplied query parameters: +Search for goals that meet supplied query parameters. GET /Goal?:parameters @@ -53,43 +59,38 @@ Search for Goals that meet supplied query parameters: Name | Required? | Type | Description -------------------|----------------------------|---------------|--------------------------------------------------------------------------------------------------------------- - `_id` | This, or patient. | [`token`] | The logical resource id associated with the Goal. Example: `_id=7891` - `patient` | This, or _id. | [`reference`] | The patient who has the goal. Example: `patient=12345` - `target-date` | N | [`date`] | A date or date range from which to find Goals. Example: `target-date=ge2016-10-01&target-date=le2016-12-01` + `_id` | Conditionally | [`token`] | The logical resource ID associated with the goal. This parameter is required if `patient` is not used. Example: `_id=7891` + `patient` | Conditionally | [`reference`] | The patient who has the goal. This parameter is required if `_id` is not used. Example: `patient=12345` + `target-date` | No | [`date`] | A date or date range from which to find goals. Example: `target-date=ge2016-10-01&target-date=le2016-12-01` `_revinclude` | No | [`token`] | Provenance resource entries to be returned as part of the bundle. Example:_revinclude=Provenance:target Notes: - - The `_id` parameter may not be provided at the same time as the `patient` or `target-date` - - - The `target-date` parameter may be provided once with a prefix to imply a date range or without a prefix to search for goals at a specific date. Alternately it may be provided twice with `le`, `lt`, `ge`, or `gt` prefixes to search for goals within specific range. The date and prefix pairs must create a closed range. - - - The `_revinclude` parameter may be provided once with the value `Provenance:target`. Example: `_revinclude=Provenance:target` - - - The `_revinclude` parameter may be provided with the `_id/patient` parameter. Example: `_id=178866310&_revinclude=Provenance:target` - - - When `_revinclude` is provided in a request to the closed endpoint, the OAuth2 token must include the scope corresponding to the Authorization Type, such as `user/Provenance.read`, `patient/Provenance.read` or `system/Provenance.read`. +* The `target-date` parameter: + * May be provided once with a prefix to imply a date range or without a prefix to search for goals at a specific date. + * Alternatively, it may be provided twice with `le`, `lt`, `ge`, or `gt` prefixes to search for goals within a specific range. The date and prefix pairs must create a closed range. +* The `_revinclude` parameter: + * May be provided once with the `Provenance:target` value. Example: `_revinclude=Provenance:target` + * May be provided with the `_id` parameter. Example: `_id=178866310&_revinclude=Provenance:target` + * May be provided with the `patient` parameter. Example `patient=1234&__revinclude=Provenance:target` + * If 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 <%= headers %> -### Example with RevInclude - -### Authorization Types - -<%= authorization_types(provider: true, system: true) %> +### Example Search by ID #### Request - GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?_id=498290085&_revinclude=Provenance:target + GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?_id=187042107 #### Response <%= headers status: 200 %> -<%= json(:r4_goal_revinclude_bundle) %> -<%= disclaimer %> +<%= json(:r4_goal_bundle_by_id) %> + ### Example Search by Patient @@ -102,55 +103,46 @@ Notes: <%= headers status: 200 %> <%= json(:r4_goal_bundle) %> -<%= disclaimer %> - - -### Example Search by Id +### Example Search by Patient and Target Date #### Request - GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?_id=187042107 + GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?patient=12724069&target-date=gt2021-01-12 #### Response <%= headers status: 200 %> -<%= json(:r4_goal_bundle_by_id) %> +<%= json(:r4_goal_bundle_by_date) %> -<%= disclaimer %> +### Example with RevInclude -### Example Search by Patient and Target Date +### Authorization Types + +<%= authorization_types(provider: true, system: true) %> #### Request - GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?patient=12724069&target-date=gt2021-01-12 + GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?_id=498290085&_revinclude=Provenance:target #### Response <%= headers status: 200 %> -<%= json(:r4_goal_bundle_by_date) %> - -<%= disclaimer %> +<%= json(:r4_goal_revinclude_bundle) %> #### Patient Authorization Request - GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?patient=12724066 + GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?patient=12724066 #### Response <%= headers status: 200 %> <%= json(:r4_goal_patient_bundle) %> -<%= disclaimer %> - -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - -## Retrieve by id +## Retrieve by ID -List an individual Goal by its id: +List an individual goal by its ID. - GET /Goal/:id + GET /Goal/:ID ### Authorization Types @@ -171,36 +163,17 @@ List an individual Goal by its id: <%= headers status: 200 %> <%= json(:r4_goal) %> -<%= disclaimer %> - -#### Patient Authorization Request - - GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal/187042107 - -#### Response - -<%= headers status: 200 %> -<%= json(:r4_goal) %> - -<%= disclaimer %> - #### Patient Authorization Request For Entered in Error Status - GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal/187042111 + GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal/187042111 #### Response <%= headers status: 200 %> <%= json(:r4_goal_entered_in_error_status) %> -<%= disclaimer %> - -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - -[`date`]: http://hl7.org/fhir/r4/search.html#date -[`reference`]: http://hl7.org/fhir/r4/search.html#reference -[`token`]: http://hl7.org/fhir/r4/search.html#token +[`date`]: https://hl7.org/fhir/r4/search.html#date +[`reference`]: https://hl7.org/fhir/r4/search.html#reference +[`token`]: https://hl7.org/fhir/r4/search.html#token [errors]: ../../../#client-errors [OperationOutcomes]: ../../../#operation-outcomes diff --git a/content/millennium/r4/clinical/medications/medication-request.md b/content/millennium/r4/clinical/medications/medication-request.md index c503c89bf..8be17cd69 100644 --- a/content/millennium/r4/clinical/medications/medication-request.md +++ b/content/millennium/r4/clinical/medications/medication-request.md @@ -9,17 +9,18 @@ title: MedicationRequest | R4 API ## Overview -The MedicationRequest resource provides orders for all medications along with administration instructions for a patient in both the inpatient and outpatient setting (orders/prescriptions filled by a pharmacy and discharge medication orders). This resource also includes a patient's historical or documented home medications reported by the patient, significant other or another provider. +The MedicationRequest resource provides orders for all medications with administration instructions for a patient in both the inpatient and outpatient settings (orders or prescriptions filled by a pharmacy and discharge medication orders). This resource also includes a patient's historical or documented home medications reported by the patient, significant other, or another provider. -If the MedicationRequest represents a prescription (something the patient takes at home), the start, stop, and other data may not be a representation of when the medication was taken. For example, the system may not know if the patient ever filled or took the prescribed medication, or when the prescription was filled. Documented historical/past/home medications are commonly captured when taking the patient’s medical history. +If the medication request represents a prescription the patient takes at home, then the start, stop, and other information may not be a representation of when the medication was taken. For example, the system may not know if the patient ever filled or took the prescribed medication, or when the prescription was filled. Documented historical, past, and home medications are commonly captured when taking the patient’s medical history. -The following [HL7® FHIR® US Core Implementation Guide STU 4.0.0](https://hl7.org/fhir/us/core/STU4/){:target="_blank"} 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/){:target="_blank"} profiles: * [US Core MedicationRequest Profile](https://hl7.org/fhir/us/core/STU4/StructureDefinition-us-core-medicationrequest.html){:target="_blank"} The following fields are returned if valued: -* [MedicationRequest id]( https://hl7.org/fhir/r4/resource-definitions.html#Resource.id){:target="_blank"} +* [MedicationRequest ID](https://hl7.org/fhir/r4/resource-definitions.html#Resource.id){:target="_blank"} +* [Extensions](#extensions) * [Status](https://hl7.org/fhir/r4/medicationrequest-definitions.html#MedicationRequest.status){:target="_blank"} * [Status Reason](https://hl7.org/fhir/r4/medicationrequest-definitions.html#MedicationRequest.statusReason){:target="_blank"} * [Intent](https://hl7.org/fhir/r4/medicationrequest-definitions.html#MedicationRequest.intent){:target="_blank"} @@ -72,6 +73,12 @@ The following fields are returned if valued: * [Allowed Boolean](https://hl7.org/fhir/r4/medicationrequest-definitions.html#MedicationRequest.substitution.allowed_x_){:target="_blank"} * [Prior Prescription](https://hl7.org/fhir/r4/medicationrequest-definitions.html#MedicationRequest.priorPrescription){:target="_blank"} +<%= disclaimer %> + +### Errors + +The common [errors] and [OperationOutcomes] may be returned. + ## Terminology Bindings <%= terminology_table(:medication_request, :r4) %> @@ -82,60 +89,74 @@ The following fields are returned if valued: ## Extensions +* [clinical-instruction] +* [pharmacy-verification-status] * [NLLPrescriptionFormat](https://simplifier.net/guide/swedishnationalmedicationlist/MedicationRequest) * [NLLRegistrationBasis](https://simplifier.net/guide/swedishnationalmedicationlist/MedicationRequest) * [NLLDosePackaging](https://simplifier.net/guide/swedishnationalmedicationlist/MedicationRequest) -All URLs for Swedish extensions are defined as `http://electronichealth.se/fhir/StructureDefinition/{id}` +### Custom Extensions - ID | Value\[x] Type | Description ------------------------------------------------------------|------------------------------------------------------------------|---------------------------------------------------------------- - `NLLPrescriptionFormat` | Coding | Current prescription format - `NLLRegistrationBasis` | Coding | Format for prescription registration - `NLLDosePackaging` | valueBoolean | Dose dispensed prescription +All URLs for custom extensions are defined as `https://fhir-ehr.cerner.com/r4/StructureDefinition/{id}` -## Custom Extensions + ID | Value\[x] Type | Description +---------------------------------|---------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------- + `clinical-instruction` | [String](https://hl7.org/fhir/r4/datatypes.html#string) | Extension to MedicationRequest.dosageInstruction. Represents instructions for an order that are intended for healthcare providers. + `pharmacy-verification-status` | [CodeableConcept](https://hl7.org/fhir/r4/datatypes.html#CodeableConcept) | Represents whether a medication request was verified by a pharmacist. Supported values are `Does not need pharmacy verification`, `Needs pharmacy verification`, or `Rejected by pharmacy`. -* Clinical Instruction: Is an extension on MedicationRequest.dosageInstruction with type of valueString. It represents instructions for an order that are intended for healthcare providers. URL for this extension is defined as: `https://fhir-ehr.cerner.com/r4/StructureDefinition/clinical-instruction`. +### Swedish Extensions -* Pharmacy Verification Status: Is an extension on MedicationRequest.extension with type of CodeableConcept. It represents whether a MedicationRequest has been verified by a pharmacist. Supported values are Does not need pharmacy verification, Needs pharmacy verification or Rejected by pharmacy. - URL for this extension is defined as: `https://fhir-ehr.cerner.com/r4/StructureDefinition/pharmacy-verification-status`. +All URLs for Swedish extensions are defined as `http://electronichealth.se/fhir/StructureDefinition/{id}` + + ID | Value\[x] Type | Description +-------------------------|-------------------------------------------------------------|----------------------------------------------------------- + `NLLPrescriptionFormat` | [Coding](https://hl7.org/fhir/r4/datatypes.html#codesystem) | Current prescription format. + `NLLRegistrationBasis` | [Coding](https://hl7.org/fhir/r4/datatypes.html#codesystem) | Format for prescription registration. + `NLLDosePackaging` | [Boolean](https://hl7.org/fhir/r4/datatypes.html#boolean) | Dose dispensed prescription. ## Search -Search for MedicationRequests that meet supplied query parameters: +Search for medication requests that meet supplied query parameters. GET /MedicationRequest?:parameters -_Implementation Notes_ - -We use the intent field to determine if a medication is an authorization or a medication reported by a patient. In the reported field, we support "Plan" and "Order" in accordance with the US Core Profile changes. - ### Authorization Types <%= authorization_types(provider: true, patient: true, system: true) %> ### Parameters - Name | Required? | Type | Description -------------------------|--------------------|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- - `_id` | This, or `patient` | [`token`] | The logical resource id associated with the resource. Example: `12345` - `patient` | This, or `_id` | [`reference`] | The specific patient to return MedicationRequests for. Example: `12345` - `status` | N | [`token`] | The [status] of the medication, may be a list separated by commas. Example: `active,completed` - `intent` | N | [`token`] | Whether the medication is an authorization or a medication reported by a patient. Example: `order,plan` - `-timing-boundsPeriod` | N | [`token`] | The date-time which should fall within the `dosageInstruction.timing.repeat.boundsPeriod` the medication should be given to the patient. Must be prefixed by `ge`. Example: `ge2014-05-19T20:54:02.000Z` - `_lastUpdated` | N | [`date`] | An explicit or implied date-time range within which the most recent clinically relevant update was made to the medication. Must include a time, and must be prefixed by `ge` or `le`. Example: `ge2014-05-19T20:54:02.000Z` - `_count` | N | [`number`] | The maximum number of results to include in a page. Example: `50` - `_revinclude` | N | [`token`] | Provenance resource entries to be returned as part of the bundle. Example:_revinclude=Provenance:target - -Notes: - -* `_revinclude` parameter may be provided once with the value `Provenance:target`. Example: `_revinclude=Provenance:target` -* `_revinclude` parameter may be provided with the `_id/patient/subject/account` parameter. Example: `_id=74771957,4732066&_revinclude=Provenance:target` + Name | Required? | Type | Description +------------------------|---------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + `_id` | Conditionally | [`token`] | The logical resource ID associated with the resource. Example: `_id=1234` + `patient` | Conditionally | [`reference`] | The specific patient to return medication requests for. Example: `patient=5678` + `status` | No | [`token`] | The [status] of the medication. May be a list separated by commas. Example: `status=active,completed` + `intent` | No | [`token`] | Whether the medication is an authorization or a medication reported by a patient. Example: `intent=order,plan` + `-timing-boundsPeriod` | No | [`token`] | The date and time which should fall within the `dosageInstruction.timing.repeat.boundsPeriod` when the medication should be given to the patient. Example: `-timing-boundsPeriod=ge2014-05-19T20:54:02.000Z` + `_lastUpdated` | No | [`date`] | The date and time range within which the most recent clinically relevant update was made to the medication. The time component is required. Example: `_lastUpdated=ge2014-05-19T20:54:02.000Z` + `_count` | No | [`number`] | The maximum number of results to include on a page. Example: `_count=50` + `_revinclude` | No | [`token`] | The Provenance resource entries to be returned as part of the bundle. Example: `_revinclude=Provenance:target` + +_Notes_ + +* When searching with the `_id` parameter: + * It must not be provided with any other parameters, except with the `_revinclude` parameter as indicated below. +* When searching with the `-timing-boundsPeriod` parameter: + * It must be provided with a `ge` prefix to imply the date range for the medications search. + * The time component is optional. + * Example: `-timing-boundsPeriod=ge2014-05-19T20:54:02.000Z` +* When searching with the `_lastUpdated` parameter: + * For a single `_lastUpdated` occurence: + * It must be provided with a `le` or `ge` prefix to imply the date range for the medications search. + * Example: `_lastUpdated=ge2014-05-19T20:54:02.000Z` + * For two `_lastUpdated` occurences: + * It must be provided with the `le` and `ge` prefixes to search for medications within the given upper and lower timestamps, respectively. + * Example: `_lastUpdated=ge2014-05-19T20:54:02.000Z&_lastUpdated=le2014-05-20T12:00:00.000Z` +* 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=74771957,4732066&_revinclude=Provenance:target` + * When `_revinclude` is provided in a request to the closed endpoint, the OAuth2 token must include the scope corresponding to the Authorization Type, such as `user/Provenance.read`, `patient/Provenance.read` or `system/Provenance.read`. -* The `_lastUpdated` 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`) ### Headers @@ -151,7 +172,6 @@ Notes: <%= headers status: 200 %> <%= json(:R4_MEDICATION_REQUEST_BUNDLE) %> -<%= disclaimer %> ### Example with RevInclude @@ -176,22 +196,13 @@ Notes: <%= headers status: 200 %> <%= json(:R4_MEDICATION_REQUEST_PATIENT_BUNDLE) %> -<%= disclaimer %> -### Errors - -The common [errors] and [OperationOutcomes] may be returned. +## Retrieve by ID -## Retrieve by id - -List an individual MedicationRequest by its id: +List an individual medication request by its ID. GET /MedicationRequest/:id -_Implementation Notes_ - -We use the intent field to determine if a medication is an authorization or a medication reported by a patient. In the reported field, we support "Plan" and "Order" in accordance with the US Core Profile changes. - ### Authorization Types <%= authorization_types(provider: true, patient: true, system: true) %> @@ -210,7 +221,6 @@ We use the intent field to determine if a medication is an authorization or a me <%= headers status: 200 %> <%= json(:R4_MEDICATION_REQUEST_ENTRY) %> -<%= disclaimer %> #### Patient Authorization Request For Active Status @@ -220,7 +230,6 @@ We use the intent field to determine if a medication is an authorization or a me <%= headers status: 200 %> <%= json(:R4_MEDICATION_REQUEST_PATIENT_ENTRY) %> -<%= disclaimer %> #### Patient Authorization Request For Entered in Error Status @@ -230,18 +239,17 @@ We use the intent field to determine if a medication is an authorization or a me <%= headers status: 200 %> <%= json(:R4_MEDICATION_REQUEST_ENTERED_IN_ERROR) %> -<%= disclaimer %> - -### Errors - -The common [errors] and [OperationOutcomes] may be returned. ## Create -Create an individual MedicationRequest. +Create an individual medication request. POST /MedicationRequest +_Notes_ + +* Only the body fields mentioned below are supported. Unsupported fields are ignored. + ### Authorization Types <%= authorization_types(provider: true, patient: false, system: true) %> @@ -276,24 +284,19 @@ Etag: W/"0" Last-Modified: Wed, 27 Mar 2019 15:59:30 GMT Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/MedicationRequest/4595905 Vary: Origin -X-Request-Id: 1638e30e497b93ff4383b2ff0eaeea68 +X-Request-Id: 11111111-1111-1111-1111-111111111111 +opc-request-id: /11111111111111111111111111111111/11111111111111111111111111111111 -<%= disclaimer %> - -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - ## Patch Patch an existing medication request. PATCH /MedicationRequest/:id -_Implementation Notes_ +_Notes_ -* This implementation follows the [JSON PATCH](https://tools.ietf.org/html/rfc6902) spec. +* This implementation follows the [JSON PATCH](https://tools.ietf.org/html/rfc6902) specification. * Only operations on the paths listed below are supported. ### Authorization Types @@ -329,15 +332,12 @@ Date: Tue, 26 Mar 2019 15:42:29 GMT Etag: W/"10" Last-Modified: Tue, 26 Mar 2019 15:42:27 GMT Vary: Origin -X-Request-Id: 47306a14c8a2c3afd4ab85aa9594101d +X-Request-Id: 11111111-1111-1111-1111-111111111111 +opc-request-id: /11111111111111111111111111111111/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 @@ -345,3 +345,5 @@ The common [errors] and [OperationOutcomes] may be returned. [status]: https://www.hl7.org/fhir/r4/valueset-medicationrequest-status.html [errors]: ../../../#client-errors [OperationOutcomes]: ../../../#operation-outcomes +[clinical-instruction]: #custom-extensions +[pharmacy-verification-status]: #custom-extensions diff --git a/content/millennium/r4/clinical/request-and-response/communication.md b/content/millennium/r4/clinical/request-and-response/communication.md index 1b3a2678a..ebd4823d2 100644 --- a/content/millennium/r4/clinical/request-and-response/communication.md +++ b/content/millennium/r4/clinical/request-and-response/communication.md @@ -9,13 +9,13 @@ title: Communication | R4 API ## Overview -The Communication resource is a conveyance of information from one entity, a sender, to another entity, a receiver. The information includes encoded data and optionally a related Patient and a related Encounter. +The Communication resource is a conveyance of information from one entity, a sender, to another entity, a receiver. The information includes encoded data and optionally a related [`Patient`] and a related [`Encounter`]. The following fields are returned if valued: -* [Communication Id](https://hl7.org/FHIR/r4/communication-definitions.html#Communication.identifier) +* [ID](https://hl7.org/FHIR/r4/communication-definitions.html#Communication.identifier) * [In Response To](https://hl7.org/FHIR/r4/communication-definitions.html#Communication.inResponseTo) -* [Status (Completed)](https://hl7.org/FHIR/r4/communication-definitions.html#Communication.status) +* [Status](https://hl7.org/FHIR/r4/communication-definitions.html#Communication.status) * [Category](https://hl7.org/FHIR/r4/communication-definitions.html#Communication.category) * [Priority](https://hl7.org/FHIR/r4/communication-definitions.html#Communication.priority) * [Subject](https://hl7.org/FHIR/r4/communication-definitions.html#Communication.subject) @@ -27,6 +27,12 @@ The following fields are returned if valued: * [Sender](https://hl7.org/FHIR/r4/communication-definitions.html#Communication.sender) * [Payload](https://hl7.org/FHIR/r4/communication-definitions.html#Communication.payload) +<%= disclaimer %> + +### Errors + +The common [errors] and [OperationOutcomes] may be returned. + ## Terminology Bindings <%= terminology_table(:communication, :r4) %> @@ -39,19 +45,19 @@ All URLs for custom extensions are defined as `https://fhir-ehr.cerner.com/r4/St ID | Value\[x] Type | Description ---------------|---------------------|---------------------------------------------------------------------------------- -`reply-to` | [`Reference`] | Used to direct where replies to the communication should be sent. Must be a Group. -`email-status` | [`CodeableConcept`] | Status of the electronic communication (in-progress, completed, received). +`reply-to` | [`Reference`] | Directs where replies to the communication are sent. Must be a group. +`email-status` | [`CodeableConcept`] | The status of the electronic communication (in-progress, completed, or received). ## Search -Search for communications that meet supplied query parameters: +Search for communications that meet supplied query parameters. GET /Communication?:parameters -_Implementation Notes_ +_Notes_ -* The Content of a communication will be returned through the binary resource. A reference to the payload will be provided in the Payload section. -* Only 1000 elements max will be returned based on the date range. +* The content of a communication is returned through the Binary resource. A reference to the payload is provided in `Communication.payload.contentReference`. +* Only a maximum of 1000 elements are returned based on the date range. ### Authorization Types @@ -59,21 +65,21 @@ _Implementation Notes_ ### Parameters - Name | Required? | Type | Description --------------------|--------------------------------------------------------------------|---------------|----------------------------------------------------------------------------------------------------------------------------------------------- - `_id` | This or (`category`, `-email-status`, `recipient` and `received`) | [`token`] | The logical resource id associated with the resource. Example: `489580643.0.-4.prsnl` - `category` | (This, `recipient`, `received` and `-email-status`) or `_id` | [`token`] | A token for a [`CodeableConcept`] that points to the CodeableConcept used for Communication.category. Example: `http://terminology.hl7.org/CodeSystem/communication-category|notification` - `recipient` | (This, `category`, `received` and `-email-status`) or `_id` | [`reference`] | The recipient of the communication. Example: `Practitioner/3456783` - `received` | (This, `category`, `recipient` and `-email-status`) or `_id` | [`date`] | Date range into which the communication falls. Example: `le2017-02-01T10:30:00Z` - `-email-status` | (This, `category`, `recipient` and `received`) or `_id` | [`token`] | The status of the email. Example: `http://hl7.org/fhir/task-status|in-progress` + Name | Required? | Type | Description +-----------------------------------------------------|---------------|---------------|----------------------------------------------------------------------------------------------------------------------------------------------- + `_id` | Conditionally | [`token`] | The logical resource ID associated with the resource. This parameter is required if `category`, `-email-status`, `recipient`, and `received` are not used. Example: `489580643.0.-4.prsnl` + `category` | Conditionally | [`token`] | A token for a [`CodeableConcept`] that points to the CodeableConcept used for `Communication.category`. This parameter is required with `recipient`, `received`, and `-email-status` if `_id` is not used. Example: `http://terminology.hl7.org/CodeSystem/communication-category|notification` + `recipient:Group` or `recipient:Practitioner` | Conditionally | [`reference`] | The recipient of the communication. This parameter is required with `category`, `received`, and `-email-status` if `_id` is not used. Example: `3456783` + `received` | Conditionally | [`date`] | The date range that the communication falls within. This parameter is required with `category`, `recipient`, and `-email-status` if `_id` is not used. Example: `ge2017-02-01T10:30:00Z` + `-email-status` | Conditionally | [`token`] | The status of the email. This parameter is required with `category`, `recipient`, and `received` if `_id` is not used. Example: `http://hl7.org/fhir/task-status|in-progress` Notes: - * The `recipient` parameter must represent a Practitioner or a Group. * The `received` parameter may be provided: - * once with the `ge` prefix. - * twice with the lower value prefixed by `ge` and the higher value prefixed by `le`. + * Once with the `ge` prefix. + * Twice with the lower value prefixed by `ge` and the higher value prefixed by `le`. + * Must be provided with a time component. ### Headers @@ -89,15 +95,10 @@ _Implementation Notes_ <%= headers status: 200 %> <%= json(:r4_communication_bundle) %> -<%= disclaimer %> - -### Errors -The common [errors] and [OperationOutcomes] may be returned. - -## Retrieve by id +## Retrieve by ID -List an individual communication by its id: +List an individual communication by its ID. GET /Communication/:id @@ -119,7 +120,6 @@ List an individual communication by its id: <%= headers status: 200 %> <%= json(:r4_communication_entry) %> -<%= disclaimer %> ## Create @@ -127,10 +127,9 @@ Create a new communication. POST /Communication -_Implementation Notes_ +_Notes_ -* Only the body fields mentioned below are supported. Unsupported fields will be ignored. -* Modifier fields should not be provided, and will cause the transaction to fail. +* Only the body fields mentioned below are supported. Unsupported fields are ignored, or can cause errors. ### Authorization Types @@ -175,21 +174,15 @@ X-Runtime: 0.022706 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. - ## Patch Patch an existing communication. PATCH /Communication/:id -_Implementation Notes_ +_Notes_ -* This implementation follows the [JSON PATCH](https://tools.ietf.org/html/rfc6902) spec. +* This implementation follows RFC 6902, [JSON Patch](https://tools.ietf.org/html/rfc6902). * Only operations on the paths listed below are supported. ### Authorization Types @@ -234,15 +227,11 @@ X-Runtime: 0.826616 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. - [`reference`]: https://hl7.org/fhir/R4/search.html#reference [`token`]: https://hl7.org/fhir/R4/search.html#token [`date`]: https://hl7.org/fhir/R4/search.html#date [`CodeableConcept`]: https://hl7.org/fhir/R4/datatypes.html#codeableconcept +[`Patient`]: /millennium/r4/base/individuals/patient/ +[`Encounter`]: /millennium/r4/base/management/encounter/ [errors]: ../../../#client-errors [OperationOutcomes]: ../../../#operation-outcomes diff --git a/content/millennium/r4/foundation/conformance/structure-definition.md b/content/millennium/r4/foundation/conformance/structure-definition.md index 06ec6ea27..7c5347417 100644 --- a/content/millennium/r4/foundation/conformance/structure-definition.md +++ b/content/millennium/r4/foundation/conformance/structure-definition.md @@ -9,37 +9,37 @@ title: StructureDefinition | R4 API ## Overview -The StructureDefinition resource describes a FHIR structure including data elements and their usage. Our current implementation uses this resource to define custom extensions. +The StructureDefinition resource describes a FHIR structure including data elements and their usage. This resource is used to define custom extensions. The following fields are returned if valued: -* [Id](http://hl7.org/fhir/r4/resource-definitions.html#Resource.id){:target="_blank"} -* [URL](http://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.url){:target="_blank"} -* [Name](http://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.name){:target="_blank"} -* [Title](http://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.title){:target="_blank"} -* [Status](http://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.status){:target="_blank"} -* [Date](http://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.date){:target="_blank"} -* [Publisher](http://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.publisher){:target="_blank"} -* [Description](http://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.description){:target="_blank"} -* [Fhir version](http://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.fhirVersion){:target="_blank"} -* [Kind](http://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.kind){:target="_blank"} -* [Abstract](http://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.abstract){:target="_blank"} -* [Type](http://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.type){:target="_blank"} -* [Context](http://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.context){:target="_blank"} -* [Base definition](http://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.baseDefinition){:target="_blank"} -* [Snapshot](http://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.snapshot){:target="_blank"} -* [Differential](http://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.differential){:target="_blank"} - -## Retrieve by id - -List an individual StructureDefinition by its id: +* [ID](https://hl7.org/fhir/r4/resource-definitions.html#Resource.id){:target="_blank"} +* [URL](https://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.url){:target="_blank"} +* [Name](https://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.name){:target="_blank"} +* [Title](https://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.title){:target="_blank"} +* [Status](https://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.status){:target="_blank"} +* [Date](https://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.date){:target="_blank"} +* [Publisher](https://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.publisher){:target="_blank"} +* [Description](https://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.description){:target="_blank"} +* [FHIR version](https://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.fhirVersion){:target="_blank"} +* [Kind](https://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.kind){:target="_blank"} +* [Abstract](https://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.abstract){:target="_blank"} +* [Type](https://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.type){:target="_blank"} +* [Context](https://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.context){:target="_blank"} +* [Base definition](https://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.baseDefinition){:target="_blank"} +* [Snapshot](https://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.snapshot){:target="_blank"} +* [Differential](https://hl7.org/fhir/r4/structuredefinition-definitions.html#StructureDefinition.differential){:target="_blank"} + +## Retrieve by ID + +List an individual structure definition by its ID. GET /StructureDefinition/:id -_Implementation Notes_ +_Notes_ -* Authentication is not required to access the StructureDefinition resource -* This resource can be retrieved by its defining URL or from the StructureDefinition resource located at the [service root URL](../../#service-root-url). For example, both of these URLs work: +* Authentication is not required to access the StructureDefinition resource. +* You can retrieve this resource by its defining URL or from the StructureDefinition resource located at the [service root URL](../../#service-root-url). For example, both of these URLs work: `https://fhir-ehr.cerner.com/r4/StructureDefinition/account-balance` @@ -49,15 +49,12 @@ _Implementation Notes_ Authorization is not required. -<%= authorization_types(provider: true, patient: true, system: true) %> - ### Headers <%= headers head: {Accept: 'application/fhir+json'} %> ### Example - #### Request GET https://fhir-ehr.cerner.com/r4/StructureDefinition/account-balance @@ -67,70 +64,70 @@ Authorization is not required. <%= headers status: 200 %> <%= json(:r4_structure_definition_bundle) %> -## List of StructureDefinitions +## List of Structure Definitions ID | Description -------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------- - [`account-balance`] | Represents the account balance. - [`account-presented-form`] | Link to the PDF statement image related to the statement account. - [`account-related-parts`] | A reference to other related Accounts. - [`account-state`] | The status of the Account within the billing or correspondence workflow. - [`bill-code-schedule`] | A defined group of bill codes that drives billing behavior. - [`choice-answer`] | Indicates answers come from a list of options. - [`client-instruction`] | Represents instructions for an order that are intended for healthcare providers. + [`account-balance`] | The account balance. + [`account-presented-form`] | The link to the PDF statement image related to the statement account. + [`account-related-parts`] | The reference to other related accounts. + [`account-state`] | The status of the account in the billing or correspondence workflow. + [`bill-code-schedule`] | The defined group of bill codes that drives billing behavior. + [`choice-answer`] | The indication that answers come from a list of options. + [`client-instruction`] | The instructions for an order that are intended for healthcare providers. [`client-organization`] | The financially responsible organization. [`clinical-instruction`] | The clinical instructions for an order that are intended for healthcare providers. - [`condition-course`] | Indication of a condition's progress since diagnosis. - [`condition-lifecycle-status`] | Indication of whether a condition is active, inactive, resolved, etc. - [`condition-result`] | Indication of the presence (positive) or absence (negative) of a given condition. - [`converted-measurement`] | Returns a converted measurement of a different measurement system than the original quantity. - [`coverage-encounter`] | Reference to the Encounter associated to the encounter level Coverage. - [`communication-preference`] | Defines communication methods preferred by a patient. - [`custom-attribute`] | A client defined custom attribute for the resource. - [`description`] | A description providing additional details of the resource. + [`condition-course`] | The indication of a condition's progress since diagnosis. + [`condition-lifecycle-status`] | The indication of whether a condition is active, inactive, resolved, and so on. + [`condition-result`] | The indication of the presence (positive) or absence (negative) of a given condition. + [`converted-measurement`] | The converted measurement of a different measurement system than the original quantity. + [`coverage-encounter`] | The encounter associated with the encounter-level coverage. + [`communication-preference`] | The communication methods preferred by a patient. + [`custom-attribute`] | The client-defined custom attribute for the resource. + [`description`] | The description providing additional details of the resource. [`email-status`] | The status of the electronic communication. [`estimated-financial-responsibility-amount`] | The estimated amount to be collected for the encounter. [`estimated-financial-responsibility-not-collected-reason`] | The reason no estimated amount is collected for the encounter. - [`financial-transaction-account-number`] | A value associated to the specific payment method usually represented as the last four digits of a credit card, the check number, the EFT number or Lockbox number. - [`financial-transaction-alias`] | Client defined value to represent the combination of the type, subtype, and reason describing the financial transaction. - [`financial-transaction-allocation`] | Defines how the payment or adjustment is to be allocated across other resources. + [`financial-transaction-account-number`] | The value associated with the specific payment method usually represented as the last four digits of a credit card, the check number, the EFT number, or the lockbox number. + [`financial-transaction-alias`] | The client-defined value to represent the combination of the type, subtype, and reason describing the financial transaction. + [`financial-transaction-allocation`] | The indication of how the payment or adjustment is to be allocated across other resources. [`financial-transaction-amount`] | The total amount of the financial transaction. - [`financial-transaction-card-brand`] | Identifies the brand of credit card when credit card is used as a payment method. - [`financial-transaction-date`] | Represents the expiration date if method is card, check date if method is check, EFT date if method is EFT or Lockbox date if method is lockbox. - [`financial-transaction-location`] | Client configured value representing the location or workflow that the payment was received in. - [`financial-transaction-method`] | Describes the method of payment for the financial transaction. + [`financial-transaction-card-brand`] | The brand of credit card when a credit card is used as a payment method. + [`financial-transaction-date`] | The expiration date if the method is card, check date if the method is check, EFT date if the method is EFT, or lockbox date if the method is lockbox. + [`financial-transaction-location`] | The client-configured value representing the location or workflow that the payment was received in. + [`financial-transaction-method`] | The method of payment for the financial transaction. [`financial-transaction-tendered-amount`] | The amount of cash originally tendered for payment. This value should be greater than or equal to the amount of the cash payment. [`financial-transaction-type`] | The classification of the transaction. - [`formatted-text`] | Link to the formatted text for a note. It is used in cases when the note is not a plain text. - [`infuse-over-time`] | The length of time in minutes it took to infuse a medication. - [`is-modifiable`] | Indication of whether data is modifiable or not. - [`is-physician`] | Indication of whether the provider is a physician or not. - [`military-service-connected-indicator`] | Identifies whether an encounter is connected to military service. - [`modifier-code`] | A code providing additional detail about a product or service. + [`formatted-text`] | The link to the formatted text for a note. This link is used when the note is not in plain text. + [`infuse-over-time`] | The length of time in minutes to infuse a medication. + [`is-modifiable`] | The indication of whether data is modifiable. + [`is-physician`] | The indication of whether the provider is a physician. + [`military-service-connected-indicator`] | The indication of whether an encounter is connected to military service. + [`modifier-code`] | The code providing additional detail about a product or service. [`national-drug-product`] | The national drug product used in care. [`net-price`] | The quantity times the unit price for a resource (total price). - [`note`] | Additional details related to an element within the resource along with author and date/time information. - [`note-allowed`] | Indication of whether an additional comment is permitted. - [`note-type`] | Describes the type of note represented. This can be useful when there are multiple notes. - [`offset-by`] | Indicates a resource that this resource is offset by. This resource is no longer active when offset. - [`patient-adopted`] | Indication of whether a patient is adopted. - [`patient-friendly-display`] | An expression of the original string in terminology that patients should be able to understand. + [`note`] | The additional details related to an element in the resource with author and date and time information. + [`note-allowed`] | The indication of whether an additional comment is permitted. + [`note-type`] | The type of note represented. Note type can be useful when multiple notes exist. + [`offset-by`] | The indication of another resource that offets this resource. This resource is no longer active when offset. + [`patient-adopted`] | The indication of whether a patient is adopted. + [`patient-friendly-display`] | The display name suitable for patient viewing. [`payment-collection-status`] | The status of the payment collection for the encounter. - [`performing-location`] | A location where the resource was performed. - [`period`] | A time period defined by a start and end date/time. - [`pharmacy-verification-status`] | Represents whether a MedicationRequest has been verified by a pharmacist. - [`precision`] | Indication of the precision of a given value. - [`priority`] | The priority of the element within a list. - [`procedure-code`] | A code providing information about the procedure performed on the patient associated to the resource. + [`performing-location`] | The location where the resource was performed. + [`period`] | The time period defined by a start and end date and time. + [`pharmacy-verification-status`] | The indication of whether a medication request is verified by a pharmacist. + [`precision`] | The indication of the precision of a given value. + [`priority`] | The priority of the element in a list. + [`procedure-code`] | The code providing information about the procedure performed on the patient associated with the resource. [`quantity-conversion-factor`] | The conversion factor used to calculate the quantity for billing. - [`related-person-encounter`] | Reference to the Encounter associated to the encounter level RelatedPerson. + [`related-person-encounter`] | The encounter associated with the encounter-level related person. [`relation`] | The related person's familial relationship to the patient. [`relationship-level`] | The resource's relationship to either the patient or encounter level. - [`replaced-by`] | The resource containing this link must no longer be used. The link points forward to another resource that must be used in lieu of the resource that contains this link. - [`replacing`] | A reference to a resource that this resource is replacing. - [`reply-to`] | A link to a resource that the reply should be directed to. - [`revenue-code`] | The type of revenue or cost center providing the product and/or service. - [`transmitting-organization`] | An organization that transmitted or participated in the creation of a resource, but not the author. + [`replaced-by`] | The resource containing this link must no longer be used. The link points to another resource that must be used in lieu of the resource that contains this link. + [`replacing`] | The reference to a resource that this resource is replacing. + [`reply-to`] | The link to a resource that the reply should be directed to. + [`revenue-code`] | The type of revenue or cost center providing the product, service, or both. + [`transmitting-organization`] | The organization that transmitted or participated in the creation of a resource, but not the author. [`unit-price`] | The price of a single unit for the resource. [`account-balance`]: https://fhir-ehr.cerner.com/r4/StructureDefinition/account-balance?_format=json diff --git a/content/millennium/r4/foundation/security/provenance.md b/content/millennium/r4/foundation/security/provenance.md index bf0f60b7f..67735cf59 100644 --- a/content/millennium/r4/foundation/security/provenance.md +++ b/content/millennium/r4/foundation/security/provenance.md @@ -9,23 +9,30 @@ title: Provenance | R4 API ## Overview -The Provenance resource tracks the source of external data and is used to assess the trustworthiness and reliability of a resource. Sources can be an organization author or organization transmitter. Entities are Continuity of Care DocumentReferences (CCDs). +The Provenance resource tracks the source of external information and is used to assess the trustworthiness and reliability of a resource. Sources can be an organization author or organization transmitter. The `target` field references a resource that this Provenance entry is related to. Entities are Continuity of Care Documents (CCDs) generated through the [DocumentReference] resource. -The following [HL7® FHIR® US Core Implementation Guide STU 4.0.0](https://hl7.org/fhir/us/core/STU4/){:target="_blank"} 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/){:target="_blank"} profiles: * [US Core Provenance Profile](https://hl7.org/fhir/us/core/STU4/StructureDefinition-us-core-provenance.html){:target="_blank"} The following fields are returned if valued: -* [Provenance id](https://hl7.org/fhir/R4/resource-definitions.html#Resource.id){:target="_blank"} +* [Provenance ID](https://hl7.org/fhir/R4/resource-definitions.html#Resource.id){:target="_blank"} * [Target](https://hl7.org/fhir/R4/provenance-definitions.html#Provenance.target){:target="_blank"} * [Recorded](https://hl7.org/fhir/R4/provenance-definitions.html#Provenance.recorded){:target="_blank"} -* [Agent type (author or transmitter)](https://hl7.org/fhir/R4/provenance-definitions.html#Provenance.agent.type){:target="_blank"} -* [Agent role (source or informant)](https://hl7.org/fhir/R4/provenance-definitions.html#Provenance.agent.role){:target="_blank"} -* [Agent who (Practitioner, Device, or Organization)](https://hl7.org/fhir/R4/provenance-definitions.html#Provenance.agent.who){:target="_blank"} -* [Agent on behalf of (when Agent.who is of type Practitioner)](https://hl7.org/fhir/R4/provenance-definitions.html#Provenance.agent.onBehalfOf){:target="_blank"} +* [Agent](https://hl7.org/fhir/R4/provenance-definitions.html#Provenance.agent){:target="_blank"} + * [Agent type](https://hl7.org/fhir/R4/provenance-definitions.html#Provenance.agent.type){:target="_blank"} + * [Agent role](https://hl7.org/fhir/R4/provenance-definitions.html#Provenance.agent.role){:target="_blank"} + * [Agent who](https://hl7.org/fhir/R4/provenance-definitions.html#Provenance.agent.who){:target="_blank"} + * [Agent on behalf of (only when Agent.who is of type Practitioner)](https://hl7.org/fhir/R4/provenance-definitions.html#Provenance.agent.onBehalfOf){:target="_blank"} * [Entity role](https://hl7.org/fhir/R4/provenance-definitions.html#Provenance.entity.role){:target="_blank"} -* [Entity what (Continuity of Care DocumentReference id)](https://hl7.org/fhir/R4/provenance-definitions.html#Provenance.entity.what){:target="_blank"} +* [Entity what](https://hl7.org/fhir/R4/provenance-definitions.html#Provenance.entity.what){:target="_blank"} + +<%= disclaimer %> + +### Errors + +The common [errors] and [OperationOutcomes] may be returned. ## Terminology Bindings @@ -33,7 +40,7 @@ The following fields are returned if valued: ## Search -Search for Provenances that meet supplied query parameters: +Search for provenances that meet the supplied query parameters. GET /Provenance?:parameters @@ -43,10 +50,30 @@ Search for Provenances that meet supplied query parameters: ### Parameters - Name | Required? | Type | Description ---------------|-----------|---------------|----------------------------------------------------------------------------------------------------------------------------------------------- - `_id` | This or `target` | [`token`] | The logical resource id associated with the resource. Example: `doc-7845` - `target` | This or `_id` | [`reference`] | Target Reference(s) (usually version specific). The AllergyIntolerance, CarePlan, CareTeam, Condition, DiagnosticReport, DocumentReference, Encounter, Goal, Immunization, MedicationRequest, Observation, Patient and Procedure resources are supported. Example: `DocumentReference/66547` + 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 `target` parameter is not used. Example: `_id=doc-1234` + `target` | Conditionally | [`reference`] | The target references, which can be version-specific. See Notes for list of supported resources. Example: `target=DocumentReference/66547` + +_Notes_ + +- When searching with the `_id` parameter: + - Must not include any other parameters. +- When searching with the `target` parameter: + - The following resources are supported at this time: + - AllergyIntolerance + - CarePlan + - CareTeam + - Condition + - DiagnosticReport + - DocumentReference + - Encounter + - Goal + - Immunization + - MedicationRequest + - Observation + - Patient + - Procedure ### Headers @@ -63,8 +90,6 @@ Search for Provenances that meet supplied query parameters: <%= headers status: 200 %> <%= json(:r4_provenance_bundle) %> -<%= disclaimer %> - #### Patient Authorization Request GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance?_id=all-1595070 @@ -74,15 +99,9 @@ Search for Provenances that meet supplied query parameters: <%= headers status: 200 %> <%= json(:r4_provenance_patient_access_entry) %> -<%= disclaimer %> - -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - -## Retrieve by id +## Retrieve by ID -List an individual Provenance by its id: +List an individual provenance by its ID. GET /Provenance/:id @@ -105,8 +124,6 @@ List an individual Provenance by its id: <%= headers status: 200 %> <%= json(:r4_provenance_entry) %> -<%= disclaimer %> - #### Patient Authorization Request GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance/all-1595070 @@ -116,23 +133,16 @@ List an individual Provenance by its id: <%= headers status: 200 %> <%= json(:r4_provenance_patient_access_bundle) %> -<%= disclaimer %> - -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - ## Create -Create a new Provenance. +Create a new provenance. POST /Provenance -_Implementation Notes_ +_Notes_ -* Only the body fields mentioned below are supported. Unsupported fields will be ignored. -* Modifier fields should not be provided, and will cause the transaction to fail. -* The `Provenance.write` scopes must be provided in order to create a Provenance with an Observation Measurement target. +* Only the body fields mentioned below are supported. Unsupported fields are ignored or can result in errors. +* The `Provenance.write` scope must be provided to create a provenance with an Observation Measurement Target. ### Authorization Types @@ -168,18 +178,14 @@ Etag: W/"881057" Location: https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance/doc-881057 Last-Modified: Tue, 31 Mar 2020 15:37:25 GMT 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. -<%= disclaimer %> - -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - [`reference`]: https://hl7.org/fhir/r4/search.html#reference [`token`]: https://hl7.org/fhir/R4/search.html#token [errors]: ../../../#client-errors [OperationOutcomes]: ../../../#operation-outcomes +[DocumentReference]: ../../documents/document-reference/#overview diff --git a/lib/resources/dstu2/contained_medication.yaml b/lib/resources/dstu2/contained_medication.yaml index bcd274b53..5b150f0e1 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": { @@ -26,7 +26,7 @@ fields: terminology: - display: RxNorm system: http://www.nlm.nih.gov/research/umls/rxnorm - info_link: http://hl7.org/fhir/dstu2/rxnorm.html + 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_order.yaml b/lib/resources/dstu2/medication_order.yaml index 334e1bed5..38b3f5678 100644 --- a/lib/resources/dstu2/medication_order.yaml +++ b/lib/resources/dstu2/medication_order.yaml @@ -1,25 +1,25 @@ --- name: MedicationOrder -field_name_base_url: http://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder +field_name_base_url: https://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder fields: - name: reasonCodeableConcept required: 'No' type: CodeableConcept description: The reason or indication for writing the prescription. - url: http://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.reason_x_ + url: https://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.reason_x_ binding: description: The reason or indication for writing the prescription. terminology: - display: SNOMED CT system: http://snomed.info/sct - info_link: http://hl7.org/fhir/dstu2/snomedct.html + info_link: https://hl7.org/fhir/dstu2/snomedct.html - display: ICD-9-CM system: http://hl7.org/fhir/sid/icd-9-cm - info_link: http://hl7.org/fhir/icd.html + info_link: https://terminology.hl7.org/ICD.html#icd-9-variants - display: ICD-10-CM system: http://hl7.org/fhir/sid/icd-10-cm - info_link: http://hl7.org/fhir/icd.html + info_link: https://terminology.hl7.org/CodeSystem-icd10CM.html - name: medicationCodeableConcept required: 'Yes' @@ -31,7 +31,7 @@ fields: terminology: - display: RxNorm system: http://www.nlm.nih.gov/research/umls/rxnorm - info_link: http://hl7.org/fhir/dstu2/rxnorm.html + info_link: https://hl7.org/fhir/dstu2/rxnorm.html - name: dosageInstruction required: 'No' @@ -57,42 +57,42 @@ fields: required: 'No' type: CodeableConcept description: A code for the timing pattern. - 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: http://hl7.org/fhir/dstu2/valueset-timing-abbreviation.html + info_link: https://hl7.org/fhir/dstu2/valueset-timing-abbreviation.html - display: SNOMED CT system: http://snomed.info/sct - info_link: http://hl7.org/fhir/dstu2/snomedct.html + info_link: https://hl7.org/fhir/dstu2/snomedct.html - name: asNeeded[x] required: 'No' type: boolean | CodeableConcept description: > Indicates whether the Medication is only taken when needed or the preconditions for taking the medication. - url: http://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.dosage.asNeeded_x_ + url: https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.dosage.asNeeded_x_ binding: description: > Indicates whether the Medication is only taken when needed or the preconditions for taking the medication. terminology: - display: SNOMED CT system: http://snomed.info/sct - info_link: http://hl7.org/fhir/dstu2/snomedct.html + info_link: https://hl7.org/fhir/dstu2/snomedct.html - name: siteCodeableConcept required: 'No' type: CodeableConcept description: The anatomic site where the medication first enters the body. - url: http://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.dosageInstruction.site_x_ + url: https://hl7.org/fhir/DSTU2/medicationorder-definitions.html#MedicationOrder.dosageInstruction.site_x_ binding: description: The anatomic site where the medication first enters the body. terminology: - display: SNOMED CT system: http://snomed.info/sct - info_link: http://hl7.org/fhir/dstu2/snomedct.html + info_link: https://hl7.org/fhir/dstu2/snomedct.html - name: route required: 'No' @@ -106,7 +106,7 @@ fields: terminology: - display: SNOMED CT system: http://snomed.info/sct - info_link: http://hl7.org/fhir/dstu2/snomedct.html + info_link: https://hl7.org/fhir/dstu2/snomedct.html - 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 diff --git a/lib/resources/dstu2/patient.yaml b/lib/resources/dstu2/patient.yaml index 3b6993f1b..f482d2156 100644 --- a/lib/resources/dstu2/patient.yaml +++ b/lib/resources/dstu2/patient.yaml @@ -1,6 +1,6 @@ --- name: Patient -field_name_base_url: http://hl7.org/fhir/DSTU2/patient-definitions.html#Patient +field_name_base_url: https://hl7.org/fhir/DSTU2/patient-definitions.html#Patient fields: - name: identifier type: List of Identifier @@ -11,15 +11,17 @@ fields: - name: type type: CodeableConcept description: The type for the identifier that can be used to determine which identifier to use for a specific purpose. - url: http://hl7.org/fhir/dstu2/datatypes-definitions.html#Identifier.type + url: https://hl7.org/fhir/dstu2/datatypes-definitions.html#Identifier.type action: terminology binding: description: The type used to determine which identifier to use for a specific purpose. terminology: - display: Identifier Type Codes system: http://hl7.org/fhir/identifier-type + info_link: https://hl7.org/fhir/DSTU2/valueset-identifier-type.html - display: v2 Identifier Type system: http://hl7.org/fhir/v2/0203 + info_link: https://hl7.org/fhir/DSTU2/v2/0203/index.html - name: contact type: List of BackboneElement @@ -36,6 +38,7 @@ fields: terminology: - display: PatientContactRelationship system: http://hl7.org/fhir/patient-contact-relationship + info_link: https://hl7.org/fhir/DSTU2/valueset-patient-contact-relationship.html - name: resourceType required: 'Yes' @@ -46,8 +49,8 @@ fields: { "resourceType": "Patient" } - note: resourceType must be Patient - url: http://hl7.org/fhir/DSTU2/json.html#resources + note: resourceType must be `Patient` + url: https://hl7.org/fhir/DSTU2/json.html#resources - name: identifier required: 'Yes' @@ -59,7 +62,7 @@ fields: "identifier": [ { "assigner": { - "reference": "Organization/619848" + "reference": "Organization/685844" } }, { @@ -80,22 +83,22 @@ fields: } ] } - note: The first identifier must only contain an `assigner` field with a reference to the Organization in which the patient is being enrolled. - The subsequent identifiers must not contain the `assigner` and `use` fields, must contain the `type`, `system`, and `value` fields, - and must include a time component when specifying a `period`. - url: http://hl7.org/fhir/dstu2/datatypes.html#Identifier - -- name: active - required: 'No' - type: boolean - description: Whether this patient record is in active use. - action: create - example: | - { - "active": true - } - note: If set, active must be true - url: http://hl7.org/fhir/dstu2/patient-definitions.html#Patient.active + note: | + + url: https://hl7.org/fhir/dstu2/datatypes.html#Identifier - name: name required: 'Yes' @@ -135,12 +138,44 @@ fields: Only one `family` name. If additional family names are required they must be provided as a single string separated by blank spaces. Up to two `given` names may be provided. If additional given names are required they must be provided in the second value as a single string separated by blank spaces. Only one `prefix` and one `suffix` may be provided. - url: http://hl7.org/fhir/dstu2/patient-definitions.html#Patient.name + + url: https://hl7.org/fhir/dstu2/patient-definitions.html#Patient.name + +- name: active + required: 'No' + type: boolean + description: Whether this patient record is in active use. + action: create + example: | + { + "active": true + } + note: If set, the value must be `true` + url: https://hl7.org/fhir/dstu2/patient-definitions.html#Patient.active - name: telecom required: 'No' type: List of ContactPoint - description: A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. + description: A contact detail (e.g., a telephone number or an email address) by which the patient may be contacted. action: create example: | { @@ -156,7 +191,7 @@ fields: ] } note: All values must contain the `system`, `use`, and `value` fields. - url: http://hl7.org/fhir/dstu2/patient-definitions.html#Patient.telecom + url: https://hl7.org/fhir/dstu2/patient-definitions.html#Patient.telecom - name: gender required: 'No' @@ -167,7 +202,7 @@ fields: { "gender": "male" } - url: http://hl7.org/fhir/dstu2/patient-definitions.html#Patient.gender + url: https://hl7.org/fhir/dstu2/patient-definitions.html#Patient.gender - name: birthDate required: 'No' @@ -176,9 +211,9 @@ fields: action: create example: | { - "birthDate": "1990-09-15" + "birthDate": "1989-09-17" } - url: http://hl7.org/fhir/dstu2/patient-definitions.html#Patient.birthDate + url: https://hl7.org/fhir/dstu2/patient-definitions.html#Patient.birthDate - name: address required: 'No' @@ -205,8 +240,8 @@ fields: } ] } - note: Each address must contain the `use` field, and must not contain the `text` field. - url: http://hl7.org/fhir/dstu2/patient-definitions.html#Patient.address + note: Each address must contain the `use` field and must not contain the `text` field. + url: https://hl7.org/fhir/dstu2/patient-definitions.html#Patient.address - name: maritalStatus required: 'No' @@ -218,15 +253,15 @@ fields: "maritalStatus": { "coding": [ { - "system": "http://hl7.org/fhir/v3/NullFlavor", - "code": "UNK", - "display": "Unknown" + "system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus", + "code": "S", + "display": "Never Married" } ], - "text": "Unknown" + "text": "Single" }, } - url: http://hl7.org/fhir/dstu2/patient-definitions.html#Patient.maritalStatus + url: https://hl7.org/fhir/dstu2/patient-definitions.html#Patient.maritalStatus - name: communication required: 'No' @@ -254,7 +289,7 @@ fields: note: Only one communication may be provided.

All the language codes must use ISO-639-1 alpha 2 code in lower case, e.g. "en" for English. - url: http://hl7.org/fhir/dstu2/patient-definitions.html#Patient.communication + url: https://hl7.org/fhir/dstu2/patient-definitions.html#Patient.communication - name: careProvider required: 'No' @@ -272,8 +307,8 @@ fields: } ] } - note: careProvider must be a reference to a Practitioner - url: http://hl7.org/fhir/dstu2/patient-definitions.html#Patient.careProvider + note: The careProvider must be a reference to a Practitioner. + url: https://hl7.org/fhir/dstu2/patient-definitions.html#Patient.careProvider - name: Birth Sex Extension required: 'No' @@ -289,4 +324,4 @@ fields: } ], } - url: http://argonautwiki.hl7.org/index.php?title=Draft_Birth_Sex_Extension + url: https://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-birthsex.html diff --git a/lib/resources/dstu2/person.yaml b/lib/resources/dstu2/person.yaml index 33733446b..033ffa1a2 100644 --- a/lib/resources/dstu2/person.yaml +++ b/lib/resources/dstu2/person.yaml @@ -1,6 +1,6 @@ --- name: Person -field_name_base_url: http://hl7.org/fhir/DSTU2/person-definitions.html#Person +field_name_base_url: https://hl7.org/fhir/DSTU2/person-definitions.html#Person fields: - name: identifier required: 'No' @@ -12,13 +12,13 @@ fields: required: 'No' type: CodeableConcept description: The type for the identifier that can be used to determine which identifier to use for a specific purpose. - url: http://hl7.org/fhir/dstu2/datatypes-definitions.html#Identifier.type + url: https://hl7.org/fhir/dstu2/datatypes-definitions.html#Identifier.type binding: description: The type used to determine which identifier to use for a specific purpose. terminology: - display: Identifier Type Codes system: http://hl7.org/fhir/identifier-type - info_link: http://hl7.org/fhir/DSTU2/valueset-identifier-type.html + info_link: https://hl7.org/fhir/DSTU2/valueset-identifier-type.html - display: v2 Identifier Type system: http://hl7.org/fhir/v2/0203 - info_link: http://hl7.org/fhir/DSTU2/valueset-identifier-type.html + info_link: https://hl7.org/fhir/DSTU2/v2/0203/index.html diff --git a/lib/resources/dstu2/practitioner.yaml b/lib/resources/dstu2/practitioner.yaml index 8ca4f1c50..45021916a 100644 --- a/lib/resources/dstu2/practitioner.yaml +++ b/lib/resources/dstu2/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: identifier required: 'No' @@ -12,13 +12,13 @@ fields: required: 'No' type: CodeableConcept description: The type for the identifier that can be used to determine which identifier to use for a specific purpose. - url: http://hl7.org/fhir/dstu2/datatypes-definitions.html#Identifier.type + url: https://hl7.org/fhir/dstu2/datatypes-definitions.html#Identifier.type binding: description: The type used to determine which identifier to use for a specific purpose. terminology: - display: Identifier Type Codes system: http://hl7.org/fhir/identifier-type - info_link: http://hl7.org/fhir/DSTU2/valueset-identifier-type.html + info_link: https://hl7.org/fhir/DSTU2/valueset-identifier-type.html - display: v2 Identifier Type system: http://hl7.org/fhir/v2/0203 - info_link: http://hl7.org/fhir/DSTU2/valueset-identifier-type.html + info_link: https://hl7.org/fhir/DSTU2/valueset-identifier-type.html diff --git a/lib/resources/example_json/dstu2_examples_patient.rb b/lib/resources/example_json/dstu2_examples_patient.rb index 9279c74f7..dd731ddea 100644 --- a/lib/resources/example_json/dstu2_examples_patient.rb +++ b/lib/resources/example_json/dstu2_examples_patient.rb @@ -295,12 +295,12 @@ module Resources 'maritalStatus': { 'coding': [ { - 'system': 'http://hl7.org/fhir/v3/NullFlavor', - 'code': 'UNK', - 'display': 'Unknown' + 'system': 'http://hl7.org/fhir/v3/MaritalStatus', + 'code': 'S', + 'display': 'Never Married' } ], - 'text': 'Unknown' + 'text': 'Single' }, 'communication': [ { diff --git a/lib/resources/example_json/dstu2_examples_practitioner.rb b/lib/resources/example_json/dstu2_examples_practitioner.rb index 7f2a2ba49..d76882b13 100644 --- a/lib/resources/example_json/dstu2_examples_practitioner.rb +++ b/lib/resources/example_json/dstu2_examples_practitioner.rb @@ -7,45 +7,32 @@ module Resources 'resourceType': 'Practitioner', 'id': '4122622', 'meta': { - 'versionId': '18', - 'lastUpdated': '2016-04-28T15:01:59.000Z' + 'versionId': '19', + 'lastUpdated': '2021-07-01T13:16:02.000Z' }, 'text': { 'status': 'generated', 'div': '

Practitioner

Name: Cerner Test, Physician - Hospitalist Cerner

'\ - '

Identifiers: EXTERNALID: CERNERPHYSHOSP, NPI: 1111111111, MESSAGING: 4122622

'\ - '

Status: Active

' + '

Identifiers: NPI: 1111111111

Status: Active

' }, 'identifier': [ { 'use': 'usual', 'type': { - 'text': 'External Identifier' - }, - 'value': 'CERNERPHYSHOSP', - 'period': { - 'start': '2016-04-28T15:01:59.000Z' - } - }, - { - 'use': 'usual', - 'type': { + 'coding': [ + { + 'system': 'http://hl7.org/fhir/v2/0203', + 'code': 'NPI', + 'display': 'National provider identifier' + } + ], 'text': 'National Provider Identifier' }, + 'system': 'http://hl7.org/fhir/sid/us-npi', 'value': '1111111111', 'period': { 'start': '2015-10-14T05:00:00.000Z' } - }, - { - 'use': 'usual', - 'type': { - 'text': 'Messaging' - }, - 'value': '4122622', - 'period': { - 'start': '2015-08-18T05:00:00.000Z' - } } ], 'active': true, @@ -60,7 +47,7 @@ module Resources 'Cerner' ], 'period': { - 'start': '2016-04-28T15:01:59.000Z' + 'start': '2015-09-22T20:58:42.000Z' } } }.freeze diff --git a/lib/resources/example_json/dstu2_examples_structure_definition.rb b/lib/resources/example_json/dstu2_examples_structure_definition.rb index 5f020ca5a..fbab01587 100644 --- a/lib/resources/example_json/dstu2_examples_structure_definition.rb +++ b/lib/resources/example_json/dstu2_examples_structure_definition.rb @@ -26,8 +26,8 @@ module Resources { 'path': 'Extension', 'short': 'String equivalent with patient-friendly terminology', - 'definition': 'An expression of the original string in terminology that patients should be able to '\ - 'understand', + 'definition': 'An expression of the original string in terminology that patients should be able to ' \ + 'understand', 'min': 0, 'max': '1', 'base': { @@ -86,10 +86,10 @@ module Resources ], 'short': 'identifies the meaning of the extension', 'definition': 'Source of the definition for the extension code - a logical name or a URL.', - 'comments': 'The definition may point directly to a computable or human-readable definition of the '\ - 'extensibility codes, or it may be a logical URI as declared in some other specification. '\ - 'The definition should be version specific. This will ideally be the URI for the Resource '\ - 'Profile defining the extension, with the code for the extension after a #.', + 'comments': 'The definition may point directly to a computable or human-readable definition of the ' \ + 'extensibility codes, or it may be a logical URI as declared in some other specification. The ' \ + 'definition should be version specific. This will ideally be the URI for the Resource ' \ + 'Profile defining the extension, with the code for the extension after a #.', 'min': 1, 'max': '1', 'base': { @@ -107,8 +107,8 @@ module Resources { 'path': 'Extension.valueString', 'short': 'Value of extension', - 'definition': 'Value of extension - may be a resource or one of a constrained set of the data types '\ - '(see Extensibility in the spec for list).', + 'definition': 'Value of extension - may be a resource or one of a constrained set of the data types (see ' \ + 'Extensibility in the spec for list).', 'min': 1, 'max': '1', 'base': { @@ -129,8 +129,8 @@ module Resources { 'path': 'Extension', 'short': 'String equivalent with patient-friendly terminology', - 'definition': 'An expression of the original string in terminology that patients should be able to '\ - 'understand', + 'definition': 'An expression of the original string in terminology that patients should be able to ' \ + 'understand', 'min': 0, 'max': '1', 'type': [ diff --git a/lib/resources/example_json/r4_examples_person.rb b/lib/resources/example_json/r4_examples_person.rb index 623f4359c..161789fd9 100644 --- a/lib/resources/example_json/r4_examples_person.rb +++ b/lib/resources/example_json/r4_examples_person.rb @@ -37,160 +37,27 @@ module Resources }, 'identifier': [ { - 'id': 'CI-490016886-0', - 'use': 'usual', - 'type': { - 'coding': [ + "id": 'CI-490525912-3', + "use": 'usual', + "type": { + "coding": [ { - 'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4', - 'code': '10', - 'display': 'MRN', - 'userSelected': true + "system": 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4', + "code": '10', + "display": 'MRN', + "userSelected": true }, { - 'system': 'http://terminology.hl7.org/CodeSystem/v2-0203', - 'code': 'MR', - 'display': 'Medical record number', - 'userSelected': false + "system": 'http://terminology.hl7.org/CodeSystem/v2-0203', + "code": 'MR', + "display": 'Medical record number', + "userSelected": false } ], - 'text': 'MRN' + "text": 'MRN' }, - 'system': 'urn:oid:2.16.840.1.113883.6.1000', - 'value': '6931', - 'period': { - 'start': '2019-12-26T15:14:12.000Z' - } - }, - { - 'id': 'CI-490058771-1', - 'use': 'usual', - 'type': { - 'coding': [ - { - 'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4', - 'code': '10', - 'display': 'MRN', - 'userSelected': true - }, - { - 'system': 'http://terminology.hl7.org/CodeSystem/v2-0203', - 'code': 'MR', - 'display': 'Medical record number', - 'userSelected': false - } - ], - 'text': 'MRN' - }, - 'system': 'urn:oid:2.16.840.1.113883.6.1000', - 'value': '6978', - 'period': { - 'end': '2020-07-06T21:21:25.000Z' - } - }, - { - 'id': 'CI-490059574-3', - 'use': 'usual', - 'type': { - 'coding': [ - { - 'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4', - 'code': '670843', - 'display': 'Messaging', - 'userSelected': true - }, - { - 'system': 'http://terminology.hl7.org/CodeSystem/v2-0203', - 'code': 'U', - 'display': 'Unspecified identifier', - 'userSelected': false - } - ], - 'text': 'Messaging' - }, - 'value': '3C36293A3B964994AD8E6C0305F3330A', - 'period': { - 'start': '2020-06-30T20:08:26.000Z' - } - }, - { - 'id': 'CI-490058805-4', - 'use': 'usual', - 'type': { - 'coding': [ - { - 'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4', - 'code': '670843', - 'display': 'Messaging', - 'userSelected': true - }, - { - 'system': 'http://terminology.hl7.org/CodeSystem/v2-0203', - 'code': 'U', - 'display': 'Unspecified identifier', - 'userSelected': false - } - ], - 'text': 'Messaging' - }, - 'value': '43DA797A657B47548F258A9B50EB41F5', - 'period': { - 'start': '2020-06-12T16:03:32.000Z' - } - }, - { - 'id': 'CI-490059570-5', - 'use': 'usual', - 'type': { - 'coding': [ - { - 'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4', - 'code': '2553236771', - 'display': 'Federated Person Principal', - 'userSelected': true - }, - { - 'system': 'http://terminology.hl7.org/CodeSystem/v2-0203', - 'code': 'AN', - 'display': 'Account number', - 'userSelected': false - } - ], - 'text': 'Federated Person Principal' - }, - 'system': 'urn:oid:2.16.840.1.113883.3.13.6', - 'value': 'URN:CERNER:IDENTITY-FEDERATION:REALM:E8A84236-C258-4952-98B7-A6FF8A9C587A-CH:PRINCIPAL:'\ - 'AN7TD9A62CV8Z53Z', - 'period': { - 'start': '2020-06-30T20:08:25.000Z' - } - }, - { - 'id': 'CI-490058801-6', - 'use': 'usual', - 'type': { - 'coding': [ - { - 'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4', - 'code': '2553236771', - 'display': 'Federated Person Principal', - 'userSelected': true - }, - { - 'system': 'http://terminology.hl7.org/CodeSystem/v2-0203', - 'code': 'AN', - 'display': 'Account number', - 'userSelected': false - } - ], - 'text': 'Federated Person Principal' - }, - 'system': 'urn:oid:2.16.840.1.113883.3.13.6', - 'value': 'URN:CERNER:IDENTITY-FEDERATION:REALM:E8A84236-C258-4952-98B7-A6FF8A9C587A-CH:PRINCIPAL:'\ - 'KR8KC9MI9EQ8KC23', - 'period': { - 'start': '2020-06-12T16:03:29.000Z' - } + "system": 'urn:oid:2.16.840.1.113883.6.1000', + "value": '31577' } ], 'name': [ @@ -205,19 +72,6 @@ module Resources 'period': { 'start': '2019-12-26T15:14:12.000Z' } - }, - { - 'id': 'CI-490059796-0', - 'use': 'old', - 'text': 'SMART, STEPHEN ALLEN', - 'family': 'SMART', - 'given': [ - 'STEPHEN', - 'ALLEN' - ], - 'period': { - 'end': '2020-07-06T21:21:26.000Z' - } } ], 'telecom': [ @@ -240,7 +94,7 @@ module Resources { 'id': 'CI-EM-29822662-0', 'system': 'email', - 'value': 'joesmart@yopmail.com', + 'value': 'joesmart@example.com', 'use': 'home', 'rank': '1', 'period': { @@ -254,11 +108,11 @@ module Resources { 'id': 'CI-24313553-0', 'use': 'home', - 'text': '12345 Main St\nKansas city, MO 64116\nUS', + 'text': '12345 Main St\nKansas City, MO 64116\nUS', 'line': [ '12345 Main St' ], - 'city': 'Kansas city', + 'city': 'Kansas City', 'district': 'Jackson', 'state': 'MO', 'postalCode': '64116', diff --git a/lib/resources/example_json/r4_examples_practitioner.rb b/lib/resources/example_json/r4_examples_practitioner.rb index 4c21ea926..dd700006e 100644 --- a/lib/resources/example_json/r4_examples_practitioner.rb +++ b/lib/resources/example_json/r4_examples_practitioner.rb @@ -5,16 +5,16 @@ module Resources R4_PRACTITIONER_ENTRY ||= { 'resourceType': 'Practitioner', - 'id': '109413936', + 'id': '4122622', 'meta': { - 'versionId': '0', - 'lastUpdated': '2019-03-07T20:40:34.000Z' + 'versionId': '20', + 'lastUpdated': '2023-11-08T20:50:26.000Z' }, 'text': { 'status': 'generated', - 'div': '

Practitioner

Name: Lombardi, '\ - 'Falco Shine

Identifiers: DOCUPIN: F88788, DOCDEA: 887887887, SPI: 16611661, NPI: 6656656, '\ - 'PRSNLPRIMID: 12332122

Gender: Male

Status: Active

' + 'div': '

Practitioner

Name: Cerner Test, '\ + 'Physician - Hospitalist Cerner

Identifiers: NPI: 1111111111

Gender: Other

'\ + '

Status: Active

' }, 'extension': [ { @@ -23,67 +23,6 @@ module Resources } ], 'identifier': [ - { - 'use': 'usual', - 'type': { - 'coding': [ - { - 'system': 'http://terminology.hl7.org/CodeSystem/v2-0203', - 'code': 'PRN', - 'display': 'Provider number' - } - ], - 'text': 'DOCUPIN' - }, - '_system': { - 'extension': [ - { - 'url': 'http://hl7.org/fhir/StructureDefinition/data-absent-reason', - 'valueCode': 'unknown' - } - ] - }, - 'value': 'F88788', - 'period': { - 'start': '2019-03-07T20:40:35.000Z' - } - }, - { - 'use': 'usual', - 'type': { - 'coding': [ - { - 'system': 'http://terminology.hl7.org/CodeSystem/v2-0203', - 'code': 'DEA', - 'display': 'Drug Enforcement Administration registration number' - } - ], - 'text': 'DOCDEA' - }, - 'system': 'urn:oid:2.16.840.1.113883.4.814', - 'value': '887887887', - 'period': { - 'start': '2019-03-07T20:40:35.000Z' - } - }, - { - 'use': 'usual', - 'type': { - 'coding': [ - { - 'system': 'http://terminology.hl7.org/CodeSystem/v2-0203', - 'code': 'PRN', - 'display': 'Provider number' - } - ], - 'text': 'SureScripts Prescriber Index' - }, - 'system': 'urn:oid:2.16.840.1.113883.3.2054', - 'value': '16611661', - 'period': { - 'start': '2019-04-12T18:24:23.000Z' - } - }, { 'use': 'usual', 'type': { @@ -97,20 +36,9 @@ module Resources 'text': 'National Provider Identifier' }, 'system': 'http://hl7.org/fhir/sid/us-npi', - 'value': '6656656', + 'value': '1111111111', 'period': { - 'start': '2019-03-07T20:40:35.000Z' - } - }, - { - 'use': 'usual', - 'type': { - 'text': 'Personnel Primary Identifier' - }, - 'system': 'urn:oid:1.2.243.58', - 'value': '12332122', - 'period': { - 'start': '2019-04-12T18:24:23.000Z' + 'start': '2015-10-14T05:00:00.000Z' } } ], @@ -118,165 +46,70 @@ module Resources 'name': [ { 'use': 'usual', - 'text': 'Lombardi, Falco Shine', - 'family': 'Lombardi', + 'text': 'Cerner Test, Physician - Hospitalist Cerner', + 'family': 'Cerner Test', 'given': [ - 'Falco', - 'Shine' - ], - 'prefix': [ - 'Dr.' - ], - 'suffix': [ - 'M.D.' + 'Physician - Hospitalist', + 'Cerner' ], 'period': { - 'start': '2019-03-07T20:40:35.000Z' + 'start': '2015-09-22T20:58:42.000Z' } } ], 'telecom': [ { 'system': 'phone', - 'value': '7861231234', - 'use': 'work' - }, - { - 'system': 'email', - 'value': 'falco.lombardi@sfox.com', + 'value': '5555550001', 'use': 'work' } ], 'address': [ + { + 'use': 'billing', + 'text': '1989 Cornelia St\nKansas City, MO 64012\nUS', + 'line': [ + '1989 Cornelia St' + ], + 'city': 'Kansas City', + 'district': 'Jackson', + 'state': 'MO', + 'postalCode': '64012', + 'country': 'US' + }, { 'use': 'work', - 'text': '111 Corneria Dr.\nTallahassee, FL 32304\nUSA', + 'text': '1234 Main\nKansas City, MO 64111\nUS', 'line': [ - '111 Corneria Dr.' + '1234 Main' ], - 'city': 'Tallahassee', - 'district': 'Leon', - 'state': 'FL', - 'postalCode': '32304', - 'country': 'USA' + 'city': 'Kansas City', + 'state': 'MO', + 'postalCode': '64111', + 'country': 'US' } ], - 'gender': 'male', + 'gender': 'other', 'qualification': [ { 'code': { 'coding': [ { 'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/29600', - 'code': '677091', - 'display': 'MD', + 'code': '677018', + 'display': 'AMA', 'userSelected': true } ], - 'text': 'MD' + 'text': 'AMA' }, 'period': { - 'start': '2014-07-09T06:00:00.000Z' - } - }, - { - 'code': { - 'coding': [ - { - 'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/29600', - 'code': '677079', - 'display': 'PhD', - 'userSelected': true - } - ], - 'text': 'PhD' - }, - 'period': { - 'start': '2014-07-09T06:00:00.000Z' + 'start': '2016-11-08T06:00:00.000Z' } } ] }.freeze - R4_PRACTITIONER_PATIENT_ACCESS_ENTRY ||= { - 'resourceType': 'Practitioner', - 'id': '109413936', - 'meta': { - 'versionId': '0', - 'lastUpdated': '2019-03-07T20:40:34.000Z' - }, - 'text': { - 'status': 'generated', - 'div': '

Practitioner

Name: Lombardi, '\ - 'Falco Shine

Identifiers: SPI: 16611661, NPI: 6656656

Gender: Male'\ - '

Status: Active

' - }, - 'extension': [ - { - 'valueBoolean': true, - 'url': 'https://fhir-ehr.cerner.com/r4/StructureDefinition/is-physician' - } - ], - 'identifier': [ - { - 'use': 'usual', - 'type': { - 'text': 'SureScripts Prescriber Index' - }, - 'system': 'urn:oid:2.16.840.1.113883.3.2054', - 'value': '16611661', - 'period': { - 'start': '2019-04-12T18:24:23.000Z' - } - }, - { - 'use': 'usual', - 'type': { - 'coding': [ - { - 'system': 'http://terminology.hl7.org/CodeSystem/v2-0203', - 'code': 'NPI', - 'display': 'National provider identifier' - } - ], - 'text': 'National Provider Identifier' - }, - 'system': 'http://hl7.org/fhir/sid/us-npi', - 'value': '6656656', - 'period': { - 'start': '2019-03-07T20:40:35.000Z' - } - } - ], - 'active': true, - 'name': [ - { - 'use': 'usual', - 'text': 'Lombardi, Falco Shine', - 'family': 'Lombardi', - 'given': [ - 'Falco', - 'Shine' - ], - 'prefix': [ - 'Dr.' - ], - 'suffix': [ - 'M.D.' - ], - 'period': { - 'start': '2019-03-07T20:40:35.000Z' - } - } - ], - 'telecom': [ - { - 'value': 'falco.lombardi@sfox.com' - } - ], - 'gender': 'male' - }.freeze - R4_PRACTITIONER_BUNDLE ||= { 'resourceType': 'Bundle', 'id': '7ec264d2-c7c7-49b2-8478-22351c82db73', @@ -284,57 +117,18 @@ module Resources 'link': [ { 'relation': 'self', - 'url': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner?_id=109413936' - } - ], - 'entry': [ - { - 'fullUrl': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner/109413936', - 'resource': R4_PRACTITIONER_ENTRY - } - ] - }.freeze - - R4_PRACTITIONER_ACTIVE_BUNDLE ||= { - 'resourceType': 'Bundle', - 'id': '7ec264d2-c7c7-49b2-8478-22351c82db73', - 'type': 'searchset', - 'link': [ - { - 'relation': 'self', - 'url': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner?active=true&_count=100' - }, - { - "relation": 'next', - "url": 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner?active=true&_count=100&-offset=100' + 'url': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner?'\ + 'identifier=http%3A%2F%2Fhl7.org%2Ffhir%2Fsid%2Fus-npi%7C1111111111' } ], 'entry': [ { - 'fullUrl': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner/109413936', + 'fullUrl': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner/4122622', 'resource': R4_PRACTITIONER_ENTRY } ] }.freeze - R4_PRACTITIONER_PATIENT_ACCESS_BUNDLE ||= { - 'resourceType': 'Bundle', - 'id': '13230afb-0bbd-45a6-a7c9-9c6d286a2f4c', - 'type': 'searchset', - 'link': [ - { - 'relation': 'self', - 'url': 'https://fhir-myrecord.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner?_id=109413936' - } - ], - 'entry': [ - { - 'fullUrl': 'https://fhir-myrecord.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner/109413936', - 'resource': R4_PRACTITIONER_PATIENT_ACCESS_ENTRY - } - ] - }.freeze - R4_PRACTITIONER_CREATE ||= { 'resourceType': 'Practitioner', 'active': true, diff --git a/lib/resources/example_json/r4_examples_structure_definition.rb b/lib/resources/example_json/r4_examples_structure_definition.rb index e14eef110..94468ed35 100644 --- a/lib/resources/example_json/r4_examples_structure_definition.rb +++ b/lib/resources/example_json/r4_examples_structure_definition.rb @@ -13,17 +13,17 @@ module Resources 'date': '2019-08-13', 'publisher': 'Cerner', 'description': 'Represents the sum of all credits and all debits associated with the account. '\ - 'May be positive, zero or negative.', + 'May be positive, zero or negative.', 'fhirVersion': '4.0.0', 'kind': 'complex-type', 'abstract': false, - 'type': 'Extension', 'context': [ { 'type': 'element', 'expression': 'Account' } ], + 'type': 'Extension', 'baseDefinition': 'http://hl7.org/fhir/StructureDefinition/Extension', 'snapshot': { 'element': [ @@ -32,7 +32,7 @@ module Resources 'path': 'Extension', 'short': 'Represents the account balance', 'definition': 'Represents the sum of all credits and all debits associated with the account. '\ - 'May be positive, zero or negative.', + 'May be positive, zero or negative.', 'min': 0, 'max': '1', 'base': { @@ -95,9 +95,9 @@ module Resources 'short': 'identifies the meaning of the extension', 'definition': 'Source of the definition for the extension code - a logical name or a URL.', 'comment': 'The definition may point directly to a computable or human-readable definition of the '\ - 'extensibility codes, or it may be a logical URI as declared in some other specification. The '\ - 'definition should be version specific. This will ideally be the URI for the Resource Profile '\ - 'defining the extension, with the code for the extension after a #.', + 'extensibility codes, or it may be a logical URI as declared in some other specification. The '\ + 'definition should be version specific. This will ideally be the URI for the Resource Profile defining '\ + 'the extension, with the code for the extension after a #.', 'min': 1, 'max': '1', 'base': { @@ -116,8 +116,8 @@ module Resources 'id': 'Extension.valueMoney', 'path': 'Extension.valueMoney', 'short': 'Value of extension', - 'definition': 'Value of extension - may be a resource or one of a constrained set of the data '\ - 'types (see Extensibility in the spec for list).', + 'definition': 'Value of extension - may be a resource or one of a constrained set of the data types '\ + '(see Extensibility in the spec for list).', 'min': 1, 'max': '1', 'base': { @@ -140,7 +140,7 @@ module Resources 'path': 'Extension', 'short': 'Represents the account balance', 'definition': 'Represents the sum of all credits and all debits associated with the account. '\ - 'May be positive, zero or negative.', + 'May be positive, zero or negative.', 'min': 0, 'max': '1', 'type': [ diff --git a/lib/resources/r4/medication_request.yaml b/lib/resources/r4/medication_request.yaml index 5612aecfe..8776deda6 100644 --- a/lib/resources/r4/medication_request.yaml +++ b/lib/resources/r4/medication_request.yaml @@ -32,10 +32,10 @@ fields: - name: statusReason required: 'No' type: CodeableConcept - description: Reason for the current status + description: Reason for the current status. action: get binding: - description: Reason for the current status + description: Reason for the current status. terminology: - display: MedicationRequest Status Reason Codes system: http://terminology.hl7.org/CodeSystem/medicationrequest-status-reason @@ -63,10 +63,10 @@ fields: - name: category required: 'No' type: CodeableConcept - description: Type of Medication Request + description: Type of Medication Request. action: get binding: - description: Type of Medication Request + description: Type of Medication Request. terminology: - display: Medication Request Category Codes system: http://terminology.hl7.org/CodeSystem/medicationrequest-category @@ -80,10 +80,10 @@ fields: - name: priority required: 'No' type: code - description: Medication Request Priority + description: Medication Request Priority. action: get binding: - description: Medication Request Priority + description: Medication Request Priority. terminology: - display: Request Priority system: http://hl7.org/fhir/request-priority @@ -101,7 +101,7 @@ fields: - name: reported[x] required: 'Yes' type: boolean - description: Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. + description: Indicates if this record was captured as a secondary `reported` record rather than as an original primary source-of-truth record. action: create note: Must be of type boolean and must be set to `true`. example: | @@ -112,7 +112,7 @@ fields: required: 'Yes' type: CodeableConcept description: A code that defines the medication - note: Must be of type CodeableConcept. `text` and/or one `coding` with a `system` and `code` must be provided. + note: Must be of type CodeableConcept. Either `text`, or one `coding` with a `system` and `code` must be provided. example: | { "medicationCodeableConcept": { @@ -126,7 +126,7 @@ fields: } } binding: - description: A code that defines the medication + description: A code that defines the medication. terminology: - display: RxNorm system: http://www.nlm.nih.gov/research/umls/rxnorm @@ -149,7 +149,7 @@ fields: - name: encounter required: 'No' type: Reference (Encounter) - description: The Encounter this medication request was created or to which the creation of this record is tightly associated. + description: The `Encounter` this medication request was created or to which the creation of this record is tightly associated. action: create example: | { @@ -160,10 +160,10 @@ fields: - name: reasonCode required: 'No' type: CodeableConcept - description: Reason why medication is/was taken + description: Reason why medication is/was taken. action: get binding: - description: Reason why medication is/was taken + description: Reason why medication is/was taken. terminology: - display: SNOMED CT system: http://snomed.info/sct @@ -214,7 +214,7 @@ fields: type: string description: The supplemental instruction or warnings to the patient. url: https://www.hl7.org/fhir/r4/dosage-definitions.html#Dosage.additionalInstruction - note: If provided, can only be provided once. `text` is only supported. + note: If provided, can only be provided once. Only `text` supported. action: create example: | { @@ -319,7 +319,7 @@ fields: - name: code required: 'No' type: CodeableConcept - description: Code for a known/defined timing pattern + description: Code for a known/defined timing pattern. note: | url: https://www.hl7.org/fhir/r4/datatypes-definitions.html#Timing.code binding: - description: Code for a known/defined timing pattern + description: Code for a known/defined timing pattern. terminology: - display: TimingAbbreviation system: http://terminology.hl7.org/CodeSystem/v3-GTSAbbreviation diff --git a/lib/resources/r4/medication_request_contained_medication.yaml b/lib/resources/r4/medication_request_contained_medication.yaml index 3cbaa24db..0c023f4b6 100644 --- a/lib/resources/r4/medication_request_contained_medication.yaml +++ b/lib/resources/r4/medication_request_contained_medication.yaml @@ -5,9 +5,9 @@ fields: - name: code required: 'No' type: CodeableConcept - description: A code that defines the medication + description: A code that defines the medication. binding: - description: A code that defines the medication + description: A code that defines the medication. terminology: - display: RxNorm system: http://www.nlm.nih.gov/research/umls/rxnorm diff --git a/lib/resources/r4/patient.yaml b/lib/resources/r4/patient.yaml index 5efbf0096..cd42ef90d 100644 --- a/lib/resources/r4/patient.yaml +++ b/lib/resources/r4/patient.yaml @@ -152,18 +152,6 @@ fields: url: https://hl7.org/fhir/R4/datatypes.html#Identifier -- name: active - required: 'No' - type: boolean - description: Whether this patient record is in active use. - action: create - example: | - { - "active": true - } - note: If set, value must be true. - url: https://hl7.org/fhir/R4/patient-definitions.html#Patient.active - - name: name required: 'Yes' type: List of HumanName @@ -214,6 +202,18 @@ fields: url: https://hl7.org/fhir/R4/patient-definitions.html#Patient.name +- name: active + required: 'No' + type: boolean + description: Whether this patient record is in active use. + action: create + example: | + { + "active": true + } + note: If set, the value must be `true`. + url: https://hl7.org/fhir/R4/patient-definitions.html#Patient.active + - name: telecom required: 'No' type: List of ContactPoint diff --git a/lib/resources/r4/person.yaml b/lib/resources/r4/person.yaml index 4ed8c67eb..6424ec4ce 100644 --- a/lib/resources/r4/person.yaml +++ b/lib/resources/r4/person.yaml @@ -17,7 +17,7 @@ fields: description: The type used to determine which identifier to use for a specific purpose. terminology: - display: v2 Identifier Type - system: https://terminology.hl7.org/CodeSystem/v2-0203 + system: http://terminology.hl7.org/CodeSystem/v2-0203 info_link: https://hl7.org/fhir/R4/v2/0203/index.html - display: Millennium Person Identifier (Alias) Types system: https://fhir.cerner.com/<EHR source id>/codeSet/4 diff --git a/lib/resources/r4/practitioner.yaml b/lib/resources/r4/practitioner.yaml index b7ef79c5e..62e25a87d 100644 --- a/lib/resources/r4/practitioner.yaml +++ b/lib/resources/r4/practitioner.yaml @@ -1,6 +1,6 @@ --- name: Practitioner -field_name_base_url: http://hl7.org/fhir/r4/practitioner-definitions.html#Practitioner +field_name_base_url: https://hl7.org/fhir/r4/practitioner-definitions.html#Practitioner fields: - name: resourceType required: 'Yes' @@ -11,8 +11,8 @@ fields: { "resourceType": "Practitioner" } - note: resourceType must be Practitioner. - url: http://hl7.org/fhir/R4/json.html#resources + note: resourceType must be `Practitioner`. + url: https://hl7.org/fhir/R4/json.html#resources - name: name required: 'Yes' @@ -46,7 +46,7 @@ fields:
  • Must include both `given` and `family`.
  • Up to two values may be present in the `given` names array. If more than two given names are required, the second value in the array accepts whitespace-delimited strings.
  • Only one `prefix` and one `suffix` may be provided.
    • -
  • Cannot contain the `text` field.
    • +
  • Must not contain the `text` field.
  • Must not have an `end` date on `period`.
  • When specifying a `period`, the fields must include a time component with a timezone.
    • @@ -99,7 +99,7 @@ fields: - name: type type: CodeableConcept description: The type for the identifier that can be used to determine which identifier to use for a specific purpose. - url: http://hl7.org/fhir/r4/datatypes-definitions.html#Identifier.type + url: https://hl7.org/fhir/r4/datatypes-definitions.html#Identifier.type action: terminology binding: description: The type used to determine which identifier to use for a specific purpose. @@ -143,14 +143,14 @@ fields: - name: code type: CodeableConcept description: Coded representation of the qualification. - url: http://hl7.org/fhir/r4/datatypes-definitions.html#Coding.code + url: https://hl7.org/fhir/r4/datatypes-definitions.html#Coding.code action: terminology binding: description: Coded representation of the qualification. terminology: - display: Qualification codes system: http://terminology.hl7.org/CodeSystem/v2-0360|2.7 - info_link: http://hl7.org/fhir/v2/0360/2.7/index.html + info_link: https://hl7.org/fhir/R4/v2/0360/2.7/index.html - name: active required: 'No' @@ -162,4 +162,4 @@ fields: "active": true } note: If set, value must be true. - url: http://hl7.org/fhir/R4/practitioner-definitions.html#Practitioner.active + url: https://hl7.org/fhir/R4/practitioner-definitions.html#Practitioner.active diff --git a/lib/resources/r4/provenance.yaml b/lib/resources/r4/provenance.yaml index ee0beb937..076608be3 100644 --- a/lib/resources/r4/provenance.yaml +++ b/lib/resources/r4/provenance.yaml @@ -31,9 +31,23 @@ fields: } note: | url: https://hl7.org/fhir/R4/provenance-definitions.html#Provenance.target @@ -93,7 +107,7 @@ fields: type: CodeableConcept description: The participation the agent had with respect to the activity. action: create - url: https://hl7.org/fhir//R4/provenance-definitions.html#Provenance.agent.type + url: https://hl7.org/fhir/R4/provenance-definitions.html#Provenance.agent.type example: | { "type": { @@ -113,7 +127,7 @@ fields: type: CodeableConcept description: The function of the agent with respect to the activity. action: create - url: https://hl7.org/fhir//R4/provenance-definitions.html#Provenance.agent.role + url: https://hl7.org/fhir/R4/provenance-definitions.html#Provenance.agent.role example: | { "role": [ @@ -135,7 +149,7 @@ fields: type: Reference description: The individual, device or organization that participated in the event. action: create - url: https://hl7.org/fhir//R4/provenance-definitions.html#Provenance.agent.who + url: https://hl7.org/fhir/R4/provenance-definitions.html#Provenance.agent.who example: | { "who": { @@ -189,7 +203,7 @@ fields: type: Reference description: Identity of the Entity used. action: create - url: https://hl7.org/fhir//R4/provenance-definitions.html#Provenance.entity.what + url: https://hl7.org/fhir/R4/provenance-definitions.html#Provenance.entity.what example: | { "what": {