Da Vinci Payer Data Exchange, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.1.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-epdx/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/davinci-pdex/CapabilityStatement/pdex-server | Version: 2.1.1 | |||
Standards status: Trial-use | Computable Name: PdexServerCapabilityStatement | |||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License |
This Section describes the expected capabilities of the PDex Server actor which is responsible for providing responses to the queries submitted by the PDex Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by PDex Servers are defined. PDex Clients have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements.
Raw OpenAPI-Swagger Definition file | Download
Generated Narrative: CapabilityStatement pdex-server
json
, SHOULD support xml
application/json-patch+json
Note to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
server
The PDex Server SHALL:
The PDex Server SHOULD:
meta.profile
attribute for each instance.
- See the US Core Security Considerations section for requirements and recommendations. 2. A server SHALL reject any unauthorized requests by returning an
HTTP 401
unauthorized response code.
transaction
interaction.batch
interaction.search-system
interaction.history-system
interaction.The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
Resource Type | Profile | R | V-R | S | U | P | C | H-I | H-T | Searches | _include | _revinclude | Operations |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
AllergyIntolerance | Supported Profiles US Core AllergyIntolerance Profile | y | y | y | y | y | clinical-status, patient | Provenance:target | |||||
CarePlan | Supported Profiles US Core CarePlan Profile | y | y | y | y | y | category, date, patient, status, patient+category+status, patient+category+status+date, patient+category, patient+category+date | Provenance:target | |||||
CareTeam | Supported Profiles US Core CareTeam Profile | y | y | y | y | y | patient, status, role, patient+status, patient+role | CareTeam:participant:PractitionerRole , CareTeam:participant:Practitioner , CareTeam:participant:Patient , CareTeam:participant:RelatedPerson | Provenance:target | ||||
Condition | Supported Profiles US Core Condition Profile | y | y | y | y | y | category, clinical-status, patient, onset-date, asserted-date, recorded-date, abatement-date, code, encounter, patient+recorded-date, patient+asserted-date, patient+category+clinical-status, patient+onset-date, patient+abatement-date, patient+clinical-status, patient+category+encounter, patient+code, patient+category | Provenance:target | |||||
Consent | Supported Profiles PDex Provider Access Consent Profile | y | y | y | y | y | y | _id, patient | Provenance:target | ||||
Coverage | Supported Profiles HRex Member Match Coverage Profile | y | y | y | y | y | patient | Provenance:target | |||||
DiagnosticReport | Supported Profiles US Core DiagnosticReport Profile for Report and Note Exchange US Core DiagnosticReport Profile for Laboratory Results Reporting | y | y | y | y | y | status, patient, category, code, date, patient+type, patient+status | Provenance:target | |||||
DocumentReference | Supported Profiles US Core DocumentReference Profile | y | y | y | y | y | _id, status, patient, category, type, date, period, patient+type, patient+status, patient+type+period, patient+category+date, patient+category | Provenance:target | $docref | ||||
Encounter | Supported Profiles US Core Encounter Profile | y | y | y | y | y | _id, class, date, identifier, patient, location, status, type, discharge-disposition, patient+type, class+patient, patient+status, date+patient, patient+location, patient+discharge-disposition | Provenance:target | |||||
ExplanationOfBenefit | Supported Profiles PDex Prior Authorization | y | y | _id, patient, _lastUpdated, type, identifier, service-date | ExplanationOfBenefit:patient , ExplanationOfBenefit:provider , ExplanationOfBenefit:care-team , ExplanationOfBenefit:coverage , ExplanationOfBenefit:insurer , ExplanationOfBenefit:* | ||||||||
Goal | Supported Profiles US Core Goal Profile | y | y | y | y | y | lifecycle-status, patient, target-date, description, patient+target-date, patient+description, patient+lifecycle-status | Provenance:target | |||||
Group | Supported Profiles Davinci ATR Group PDex Provider Group PDex Member Match Group | y | y | y | y | y | identifier, characteristic, Group-characteristic-value-reference | $bulk-member-match , $davinci-data-export | |||||
Immunization | Supported Profiles US Core Immunization Profile | y | y | y | y | y | patient, status, date, patient+date, patient+status | Provenance:target | |||||
Location | Supported Profiles US Core Location Profile | y | y | y | y | y | name, address, address-city, address-state, address-postalcode | ||||||
Medication | Supported Profiles US Core Medication Profile | y | y | y | y | y | |||||||
MedicationDispense | Supported Profiles PDex MedicationDispense | y | y | y | y | y | status, type, patient, patient+status+type, patient+status | MedicationDispense:medication | Provenance:target | ||||
MedicationRequest | Supported Profiles US Core MedicationRequest Profile | y | y | y | y | y | status, intent, patient, encounter, authoredon, patient+intent+encounter, patient+intent+status, patient+intent+authoredon, patient+intent | MedicationRequest:medication | Provenance:target | ||||
Observation | Supported Profiles US Core Pediatric BMI for Age Observation Profile US Core Pediatric Weight for Height Observation Profile US Core Pulse Oximetry Profile US Core Smoking Status Observation Profile US Core Pediatric Head Occipital Frontal Circumference Percentile Profile US Core Pediatric Weight for Height Observation Profile US Core Pulse Oximetry Profile US Core Laboratory Result Observation Profile Vital Signs Profile | y | y | y | y | y | status, category, code, date, patient, patient+code+date, patient+category+status, patient+category+date, patient+category, patient+code | Provenance:target | |||||
Organization | Supported Profiles US Core Organization Profile | y | y | y | y | y | name, address | ||||||
Patient | Supported Profiles US Core Patient Profile | y | y | y | y | y | _id, birthdate, death-date, family, gender, given, identifier, name, birthdate+family, family+gender, birthdate+name, gender+name, death-date+family | Provenance:target | $member-match | ||||
Practitioner | Supported Profiles US Core Practitioner Profile | y | y | y | y | y | _id, name, identifier | ||||||
PractitionerRole | Supported Profiles US Core PractitionerRole Profile | y | y | y | y | y | specialty, practitioner | PractitionerRole:endpoint , PractitionerRole:practitioner | |||||
Procedure | Supported Profiles US Core Procedure Profile | y | y | y | y | y | status, patient, date, code, patient+code+date, patient+status, patient+date | Provenance:target | |||||
Provenance | Supported Profiles PDex Provenance US Core Provenance Profile | y | y | y | y | y | y | ||||||
ValueSet | $expand |
resolves
search-type
, read
.vread
, history-instance
.history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. |
MAY | clinical-status | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
Conformance | Parameters | Types |
---|---|---|
patient+clinical-status | reference +token |
resolves
search-type
, read
.vread
, history-instance
.history-type
.
- Additional considerations for systems aligning with HL7 Consolidated (C-CDA) Care Plan requirements:
- US Core Goal SHOULD be present in CarePlan.goal
- US Core Condition SHOULD be present in CarePlan.addresses
- Assessment and Plan MAY be included as narrative text
Conformance | Parameter | Type | Documentation |
---|---|---|---|
MAY | category | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
MAY | date | date | A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset. |
MAY | patient | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. |
MAY | status | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
resolves
search-type
, read
.vread
, history-instance
.history-type
.In order to access care team member's names, identifiers, locations, and contact information, the CareTeam profile supports several types of care team participants. They are represented as references to other profiles and include the following four profiles which are marked as must support:
- US Core Practitioner Profile
- US Core PractitionerRole Profile
- US Core Patient Profile
- US Core RelatedPerson Profile
- Although both US Core Practitioner Profile and US Core PractitionerRole are must support, the server system is not required to support both types of references (and
_include
search parameters), but SHALL support at least one of them.- The client application SHALL support all four profile references.
- Because the US Core PractitionerRole Profile supplies the provider's location and contact information and a reference to the Practitioner, server systems SHOULD reference it instead of the US Core Practitioner Profile.
- Servers that supports only US Core Practitioner Profile SHALL provide implementation specific guidance how to access a provider's location and contact information using only the Practitioner resource.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHOULD | role | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
MAY | patient | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. |
MAY | status | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
resolves
search-type
, read
.vread
, history-instance
.history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. |
MAY | category | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
MAY | clinical-status | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
MAY | onset-date | date | A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset. |
MAY | asserted-date | date | A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset. |
MAY | recorded-date | date | A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset. |
MAY | abatement-date | date | A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset. |
MAY | code | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
MAY | encounter | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. |
Conformance | Parameters | Types |
---|---|---|
SHALL | patient+category | reference +token |
SHOULD | patient+recorded-date | reference +date |
SHOULD | patient+asserted-date | reference +date |
SHOULD | patient+category+clinical-status | reference +token +token |
SHOULD | patient+onset-date | reference +date |
SHOULD | patient+abatement-date | reference +date |
SHOULD | patient+clinical-status | reference +token |
SHOULD | patient+category+encounter | reference +token +reference |
SHOULD | patient+code | reference +token |
resolves
read
, create
, search-type
, vread
, history-instance
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _id | string | |
SHALL | patient | reference |
resolves
search-type
, read
.vread
, history-instance
.history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. |
resolves
search-type
, read
.vread
, history-instance
.history-type
.
Implantable medical devices that have UDI information SHALL represent the UDI code in
Device.udiCarrier.carrierHRF
.
- All of the five UDI-PI elements that are present in the UDI code SHALL be represented in the corresponding US Core Implantable Device Profile element.
UDI may not be present in all scenarios such as historical implantable devices, patient reported implant information, payer reported devices, or improperly documented implants. If UDI is not present and the manufacturer and/or model number information is available, they SHOULD be included to support historical reports of implantable medical devices as follows:
manufacturer ->
Device.manufacturer
model ->Device.model
Servers SHOULD support query by Device.type to allow clients to request the patient's devices by a specific type. Note: The Device.type is too granular to differentiate implantable vs. non-implantable devices.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. |
MAY | status | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
MAY | category | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
MAY | code | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
MAY | date | date | A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset. |
resolves
search-type
, read
.vread
, history-instance
.history-type
.
- The
DocumentReference.type
binding SHALL support at a minimum the US Core 6.1 5 Common Clinical Notes and may extend to the full US Core DocumentReference Type Value Set- The DocumentReference resources can represent the referenced content using either an address where the document can be retrieved using
DocumentReference.attachment.url
or the content as inline base64 encoded data usingDocumentReference.attachment.data
.
- Although both are marked as must support, the server system is not required to support an address, and inline base64 encoded data, but SHALL support at least one of these elements.
- The client application SHALL support both elements.
- The
content.url
may refer to a FHIR Binary Resource (i.e. [base]/Binary/[id]), FHIR Document Bundle (i.e [base]/Bundle/[id] or another endpoint.
- If the endpoint is outside the FHIR base URL, it SHOULD NOT require additional authorization to access.
- Every DocumentReference must have a responsible Organization. The organization responsible for the DocumentReference SHALL be present either in
DocumentReference.custodian
or accessible in the Provenance resource targeting the DocumentReference usingProvenance.agent.who
orProvenance.agent.onBehalfOf
.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _id | token | |
SHALL | patient | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. |
MAY | status | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
MAY | category | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
MAY | type | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
MAY | date | date | A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset. |
MAY | period | date | A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset. |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $docref | A server SHALL be capable of responding to a $docref operation and capable of returning at least a reference to a generated CCD document, if available. MAY provide references to other 'on-demand' and 'stable' documents (or 'delayed/deferred assembly') that meet the query parameters as well. If a context date range is supplied the server ** SHOULD** provide references to any document that falls within the date range If no date range is supplied, then the server SHALL provide references to last or current encounter. SHOULD document what resources, if any, are returned as included resources |
resolves
search-type
, read
.vread
, history-instance
.history-type
.
The Encounter resource can represent a reason using either a code with
Encounter.reasonCode
, or a reference withEncounter.reasonReference
to Condition or other resource.
- Although both are marked as must support, the server systems are not required to support both a code and a reference, but they SHALL support at least one of these elements.
- The client application SHALL support both elements.
- if
Encounter.reasonReference
references an Observation, it SHOULD conform to a US Core Observation if applicable. (for example, a laboratory result should conform to the US Core Laboratory Result Observation Profile)The location address can be represented by either by the Location referenced by
Encounter.location.location
or indirectly through the Organization referenced byEncounter.serviceProvider
.
- Although both are marked as must support, the server systems are not required to support both
Encounter.location.location
andEncounter.serviceProvider
, but they SHALL support at least one of these elements.- The client application SHALL support both elements.
- if using
Encounter.location.location
it SHOULD conform to US Core Location.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _id | token | |
SHALL | patient | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. |
SHOULD | identifier | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
MAY | class | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
MAY | date | date | A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset. |
MAY | location | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. |
MAY | status | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
MAY | type | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
MAY | discharge-disposition | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
resolves
search-type
read
Searches using service-date, _lastUpdated, or type require a patient search argument.
_include:* SHALL be supported.
When a Prior Authorization references another resource (e.g., Patient or Practitioner), the reference may be versioned or versionless. Payers SHALL use versioned references whenever they maintain point-in-time data (data that was effective as of the date of service or date of admission on the claim), but MAY use versionless references when they do not maintain versioned data. Clients MAY request referenced resources as part of an EOB search (by supplying the _include parameter) or directly using read or vread. Payers SHALL support both approaches, and SHALL return the same content for referenced resources in either case. “:iterate" should be used if you request to include Coverage:payor in the EOB response bundle, e.g. GET [base]/ExplanationOfBenefit?[parameter=value]&_include=ExplanationOfBenefit:coverage&_include:iterate=Coverage:payor.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _id | token | |
SHALL | patient | reference | |
SHALL | _lastUpdated | date | |
SHALL | type | token | |
SHALL | identifier | token | |
SHALL | service-date | date |
resolves
search-type
, read
.vread
, history-instance
.history-type
.
- Although both
Goal.startDate
andGoal.target.dueDate
are marked as must support, the server system is not required to support both, but SHALL support at least one of these elements. The client application SHALL support both elements.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. |
MAY | lifecycle-status | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
MAY | target-date | date | A client SHALL provide a value precise to the day. A server SHALL support a value a value precise to the day. |
MAY | description | token |
Conformance | Parameters | Types |
---|---|---|
SHOULD | patient+target-date | reference +date |
SHOULD | patient+description | reference +token |
SHOULD | patient+lifecycle-status | reference +token |
search-type
Allows discovery of existing groups. SHOULD be limited to groups a requestor is permitted to access.
read
Allows retrieval of a specific Group Resource.
vread
Allows retrieval of a historical version of a Group Resource.
history-instance
Allows review of changes to a Group Resource over time.
history-type
Retrieve the change history fora Group Resource.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
SHALL | characteristic | token | A common characteristic of all members of a group. |
SHALL | Group-characteristic-value-reference | composite | multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true. multipleOr: The parameter may only have one value (no comma separators). |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $bulk-member-match | Client will submit multi-member-match-request bundle. Server will respond with a multi-member-match-response and instantiate a Group resource conforming to the PDexMemberMatchGroup that contains a set of matched members that the Server identified. |
SHALL | $davinci-data-export | Each DaVinci use case as part of its implementation guide can define the exportType parameter and the behavior expected. |
resolves
search-type
, read
.vread
, history-instance
.history-type
.
- Based upon the ONC U.S. Core Data for Interoperability (USCDI) requirements, CVX vaccine codes are required and the NDC vaccine codes SHOULD be supported as translations to them.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. |
MAY | status | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
MAY | date | date | A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset. |
resolves
search-type
, read
.vread
, history-instance
.history-type
.
- The US Core Location and PractitionerRole Profiles are not explicitly referenced in any US Core Profile. However they SHOULD be used as the default profile if referenced by another US Core profile.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | name | string | |
SHALL | address | string | |
SHOULD | address-city | string | |
SHOULD | address-state | string | |
SHOULD | address-postalcode | string |
resolves
read
.vread
, history-instance
.search-type
, history-type
.The MedicationRequest resource can represent a medication, using an external reference to a Medication resource. If an external Medication Resource is used in a MedicationRequest, then the READ SHALL be supported.
resolves
search-type
, read
.vread
, history-instance
.history-type
.The MedicationDispense resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be contained or an external resource. The server application MAY choose any one way or more than one method, but if an external reference to Medication is used, the server SHALL support the _include
parameter for searching this element. The client application must support all methods. For example, A server **SHALL** be capable of returning all medications for a patient using one of or both:
GET /MedicationDispense?patient=[id]GET /MedicationDispense?patient=[id]&_include=MedicationDispense:medication`
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. |
MAY | status | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
MAY | type | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
resolves
search-type
, read
.vread
, history-instance
.history-type
.The MedicationRequest resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be contained or an external resource. The server application MAY choose any one way or more than one method, but if an external reference to Medication is used, the server SHALL support the _include
parameter for searching this element. The client application must support all methods. For example, A server **SHALL** be capable of returning all medications for a patient using one of or both:
GET /MedicationRequest?patient=[id]GET /MedicationRequest?patient=[id]&_include=MedicationRequest:medication`
Conformance | Parameter | Type | Documentation |
---|---|---|---|
MAY | status | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
MAY | intent | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
MAY | patient | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. |
MAY | encounter | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. |
MAY | authoredon | date | A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset. |
resolves
search-type
, read
.vread
, history-instance
.history-type
.US Core Pediatric BMI for Age Observation Profile
US Core Pediatric Weight for Height Observation Profile
US Core Pulse Oximetry Profile
US Core Smoking Status Observation Profile
US Core Pediatric Head Occipital Frontal Circumference Percentile Profile
US Core Pediatric Weight for Height Observation Profile
US Core Pulse Oximetry Profile
US Core Laboratory Result Observation Profile
Vital Signs Profile
Conformance | Parameter | Type | Documentation |
---|---|---|---|
MAY | status | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
MAY | category | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
MAY | code | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
MAY | date | date | A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset. |
MAY | patient | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. |
resolves
search-type
, read
.vread
, history-instance
.history-type
.
- Systems SHALL support National Provider Identifier (NPI) for organizations and SHOULD support Clinical Laboratory Improvement Amendments (CLIA) identifiers for
Organization.Identifier
.
resolves
search-type
, read
.vread
, history-instance
.history-type
.
For ONC's USCDI requirements, each Patient must support the following additional elements. These elements are included in the formal definition of the profile. The patient examples include all of these elements.
- contact detail (e.g. a telephone number or an email address)
- a communication language
- a race
- an ethnicity
- a birth sex*
- previous name
- Previous name is represented by providing an end date in the
Patient.name.period
element for a previous name.- suffix
- Suffix is represented using the
Patient.name.suffix
element.The Patient's Social Security Numbers SHOULD NOT be used as a patient identifier in
Patient.identifier.value
.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _id | token | |
SHALL | identifier | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
SHALL | name | string | |
MAY | birthdate | date | A client SHALL provide a value precise to the day. A server SHALL support a value a value precise to the day. |
MAY | death-date | date | A client SHALL provide a value precise to the day. A server SHALL support a value a value precise to the day. |
MAY | family | string | A server SHALL support a value precise to the day. |
MAY | gender | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
MAY | given | string |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $member-match |
resolves
search-type
, read
.vread
, history-instance
.history-type
.Servers that support only US Core Practitioner Profile SHALL provide implementation specific guidance how to access a provider’s location and contact information using only the Practitioner resource.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | name | string | |
SHALL | identifier | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
SHOULD | _id | token |
resolves
search-type
, read
.vread
, history-instance
.history-type
.
- The US Core Location and PractitionerRole Profiles are not explicitly referenced in any US Core Profile. However they SHOULD be used as the default profile if referenced by another US Core profile.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | specialty | token | |
SHALL | practitioner | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. |
resolves
search-type
, read
.vread
, history-instance
.history-type
.
- Procedure codes can be taken from SNOMED-CT, CPT, HCPCS II, ICD-10-PCS, CDT. LOINC.
- Only LOINC concepts that reflect actual procedures SHOULD be used
- A procedure including an implantable device SHOULD use
Procedure.focalDevice
with a reference to the US Core Implantable Device Profile.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. |
MAY | status | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
MAY | date | date | A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset. |
MAY | code | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
resolves
read
.vread
, history-instance
.search-type
, patch
, history-type
.If a system receives a provider in
Provenance.agent.who
as free text they must capture who sent them the information as the organization. On request they SHALL provide this organization as the source and MAY include the free text provider.
Conformance | Operation | Documentation |
---|---|---|
SHOULD | $expand | A client can determine the note and report types support by a server by invoking the standard FHIR Value Set Expansion ($expand) operation defined in the FHIR R4 specification. Because servers may support different read and write formats, it also is used to determine the formats (for example, text, pdf) the server supports read and write transactions. |