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/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/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