Status: 200 OK{
@@ -639,20 +639,20 @@ Request
Status: 200 OK{
diff --git a/millennium/dstu2/devices/device/index.html b/millennium/dstu2/devices/device/index.html
index 391071334..acb0cd0a5 100644
--- a/millennium/dstu2/devices/device/index.html
+++ b/millennium/dstu2/devices/device/index.html
@@ -254,20 +254,20 @@ Request
Status: 200 OK{
@@ -346,20 +346,20 @@ Request
Status: 200 OK{
@@ -461,20 +461,20 @@ Request
Status: 200 OK{
diff --git a/millennium/dstu2/general-clinical/procedure/index.html b/millennium/dstu2/general-clinical/procedure/index.html
index dccccc474..4a6c674f3 100644
--- a/millennium/dstu2/general-clinical/procedure/index.html
+++ b/millennium/dstu2/general-clinical/procedure/index.html
@@ -68,7 +68,11 @@ Millennium
Procedure
- - Overview
+ -
+Overview
+ - Errors
+
+
- Terminology Bindings
-
Search
@@ -76,37 +80,41 @@ Procedure
- Parameters
- Headers
- Example
- - Errors
-
-Retrieve by id
Overview
-The Procedure resource returns current and historical procedures performed on a patient. A procedure can be invasive or non-invasive treatments/procedures and observations. For example, a patient who has breast cancer could have significant & pertinent procedures that include mammograms, BRCA testing, breast examination documentation & lumpectomy. It is up to the user what procedures are clinically significant to document. Surgical and radiology procedures documented in other Cerner solutions will return if manually added by a clinician in the patient’s procedure history.
+The Procedure resource returns current and historical procedures performed on a patient. A procedure can be invasive or noninvasive treatments or procedures and observations. For example, a patient who has breast cancer could have significant and pertinent procedures that include mammograms, BRCA testing, breast examination documentation, and lumpectomy. The user decides what procedures are clinically significant to document. Surgical and radiology procedures documented in other Oracle Cerner products are returned if manually added by a clinician in the patient’s procedure history.
The following fields are returned if valued:
- - Procedure id
- - Patient
- - Status (completed, entered-in-error)
- - Procedure
- - Reason performed
- - Who performed
- - Date performed
- - Patient encounter
- - Notes
+ - ID
+ - Patient
+ - Status
+ - Procedure
+ - Reason performed
+ - Who performed
+ - Date performed
+ - Patient encounter
+ - Notes
+Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
+
+Errors
+
+The common errors and OperationOutcomes may be returned.
+
Terminology Bindings
@@ -232,15 +240,15 @@ Terminology Bindings
Search
-Search for Procedures that meet supplied query parameters:
+Search for procedures that meet supplied query parameters.
GET /Procedure?:parameters
-Implementation Notes
+Notes
- - The Procedure.notPerformed modifier element is not supported and will not be returned.
+ - The Procedure.notPerformed modifier element is not supported and not returned.
Authorization Types
@@ -263,33 +271,30 @@ Parameters
_idThis, or one of patient or subject
-
- tokenThe logical resource id associated with the resource. Example: _id=7891
+ Conditionally
+ tokenThe logical resource ID associated with the resource. This parameter is required if patient or subject is not used. Example: _id=7891
patientThis, or one of _id or subject
-
- referenceThe patient subject of the Procedure. Example: patient=12345
+ Conditionally
+ referenceWho the procedure is for. This parameter is required if _id or subject is not used. Example: 12345
subjectThis, or one of _id or patient
-
- referenceThe subject of the Procedure. Must represent a Patient resource. May use the :Patient modifier. Example: subject=Patient/12345 or subject:Patient=12345
+ Conditionally
+ referenceWho the procedure is for. This parameter is required if _id or patient is not used. Example: subject=Patient/12345 or subject:Patient=12345
dateN
- dateThe date/time when the Procedure was performed. Must use the ge and/or le prefixes. Example: date=le2017-02-01T10:30:00Z
+ No
+ dateTimeThe date and time when the procedure’s performedDateTime was performed. Must use the ge or le prefix, or both prefixes. Example: date=le2017-02-01T10:30:00Z
@@ -298,11 +303,11 @@ Parameters
Notes:
- -
-
The _id parameter may not be provided at the same time as the patient, subject, or date parameters.
-
- -
-
The date 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.
+ - The
date 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.
+
@@ -404,23 +409,18 @@ Response
}
]
}
-Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
-
-Errors
-
-The common errors and OperationOutcomes may be returned.
-Retrieve by id
+Retrieve by ID
-List an individual Procedure by its id:
+List an individual procedure by its ID.
GET /Procedure/:id
-Implementation Notes
+Notes
- - The Procedure.notPerformed modifier element is not supported and will not be returned.
+ - The Procedure.notPerformed modifier element is not supported and not returned.
Authorization Types
@@ -476,11 +476,6 @@ Response
"reference": "Encounter/97953477"
}
}
-Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
-
-Errors
-
-The common errors and OperationOutcomes may be returned.
diff --git a/millennium/dstu2/infrastructure/document-reference/index.html b/millennium/dstu2/infrastructure/document-reference/index.html
index 9e79e81a7..3edba70eb 100644
--- a/millennium/dstu2/infrastructure/document-reference/index.html
+++ b/millennium/dstu2/infrastructure/document-reference/index.html
@@ -68,7 +68,11 @@ Millennium
DocumentReference
- - Overview
+ -
+Overview
+ - Errors
+
+
- Terminology Bindings
-
Search
@@ -76,15 +80,13 @@ DocumentReference
- Parameters
- Headers
- Example
- - Errors
-
-Retrieve by id
-
@@ -93,51 +95,38 @@
DocumentReference
- Headers
- Body fields
- Example
- - Errors
-Operation: docref
Overview
-The DocumentReference resource is used to reference a clinical document for a patient within the health system. This resource supports reading Continuity of Care Documents (CCD), returning a list of clinical documents, and a reference to retrieve a document as a PDF. Additionally, this resource supports writing an unstructured document. References to implicitRules, relatesTo, and modifierExtensions are NOT supported and will fail a create request.
-
-For fields supported on write, see the create section.
+The DocumentReference resource is used to reference a clinical document for a patient within the health system. This resource supports reading Continuity of Care Documents (CCD), returning a list of clinical documents, and a reference to retrieve a document as a PDF. When retrieving document links and metadata, this resource will refer to the Binary resource for downloading the complete document.
-The following fields are returned if valued for the docref operation (CCD read):
-
-
- - DocumentReference id
- - Subject (patient)
- - Document type
- - Index date/time (when document reference created)
- - Status (current)
- - Format
- - ContentType and URL (fully qualified link to the Binary CCD)
-
+Additionally, this resource supports writing an unstructured document.
+For fields supported on write, see the create section.
The following fields are returned if valued for clinical documents:
- - DocumentReference id
- - Subject (patient)
- - Document type
- - Document description/title
- - Authenticator/verifying provider
- - Create date/time
- - Indexed date/time
- - Status (typically current)
- - Document status (typically final or amended)
+ - DocumentReference ID
+ - Subject
+ - Document type
+ - Document description/title
+ - Authenticator/verifying provider
+ - Create date/time
+ - Indexed date/time
+ - Status
+ - Document status
-
Content
@@ -145,15 +134,33 @@ Overview
Attachment
- Patient encounter
+ Patient encounter
+
+
+The following fields are returned if valued for the $docref operation (CCD read):
+
+
+ - DocumentReference ID
+ - Subject
+ - Document type
+ - Index date/time
+ - Status
+ - Format
+ - ContentType and URL
+Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
+
+Errors
+
+The common errors and OperationOutcomes may be returned.
+
Terminology Bindings
@@ -263,13 +270,6 @@ Search
GET /DocumentReference?:parameters
-Implementation Notes
-
-
- - Search results are currently limited to published clinical documents.
- - Contents of the document are found by following the Attachment URL. See more information on the Binary resource to determine what Authorization scopes are required, and how to set the Accept header when downloading document contents.
-
-
Authorization Types
@@ -290,56 +290,77 @@ Parameters
_idThis, or one of patient or subject
-
- tokenThe logical resource id associated with the resource. Example: _id=7891
+ Conditionally
+ tokenThe logical resource ID associated with the resource. This parameter is required if neither the patient nor subject parameters are used. Example: _id=1234
patientThis, or one of _id or subject
-
- referenceThe patient to which the document reference belongs. Example: patient=12345
+ Conditionally
+ referenceThe patient to which the document reference belongs. This parameter is required if neither the _id nor subject parameters are used. Example: patient=5678
subjectThis, or one of _id or patient
-
- referenceThe subject of the document reference. Must represent a Patient resource. May use the :Patient modifier. Example: subject=Patient/12345 or subject:Patient=12345
+ Conditionally
+ referenceThe subject of the document reference. May use the “:Patient” modifier. This parameter is required if neither the _id nor patient parameters are used. Example: subject=Patient/91011
encounterNo
- referenceThe encounter to which the document reference belongs. Must represent an Encounter resource. May include a single or comma separated list of references. Example: encounter=4567
+ referenceThe encounter to which the document reference belongs. Example: encounter=1213
createdNo
- dateA date/time the referenced document was created. Must use the ge and le prefixes. Example: created=ge2017-01-07&created=le2017-02-05
+ dateA date/time the referenced document was created. Example: created=ge2017-01-07&created=le2017-02-05
- _count_countNo
- numbernumberThe maximum number of results to return.
-Notes:
+Implementation Notes
- - The
_id parameter may not be provided at the same time as the patient, subject, encounter, created, or _count parameters.
- - When the
created parameter is provided:
+ - Search results are currently limited to published clinical documents.
+ - Contents of the document are found by following the Attachment URL.
+
+ - See more information on the
Binary resource to determine what Authorization scopes are required, and how to set the Accept header when downloading document contents.
+
+
+ - When searching with the
_id parameter:
+
+ - It must not be provided with any other parameters.
+
+
+ - When searching with the
subject parameter:
+
+ - It must appear once, and must represent a Patient resource.
+ - It can be provided either with or without the :Patient modifier. Example:
subject=Patient/12345 or subject:Patient=12345
+
+
+
+ - When searching with the
encounter parameter:
+
+ - It must appear once, and must represent an Encounter resource.
+ - It can be provided with either a single reference, or a comma-separated list of references. Example
encounter=1234 or encounter=1234,5678
+
+
+
+ - When searching with the
created parameter:
- It must be provided twice, once with the
ge parameter and once with the le parameter.
- The two provided date/times may not be equal and must form a closed range.
@@ -437,15 +458,9 @@ Response
]
}
-Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
-
-Errors
-
-The common errors and OperationOutcomes may be returned.
+Retrieve by ID
-Retrieve by id
-
-List an individual DocumentReference by its id:
+List an individual DocumentReference by its ID:
GET /DocumentReference/:id
@@ -453,8 +468,11 @@ Retrieve by id
Implementation Notes
- - Contents of the document are found by following the Attachment URL. See more information on the Binary resource to determine what Authorization scopes are required, and how to set the Accept header when downloading document contents.
- - If no mappings are available for LOINC codes when returning DocumentReference.type codings, an unknown data absent reason will be returned in place of the LOINC codes. This is to follow the Argonaut profile’s required binding for type. When available, Proprietary codings will be returned in addition to the data absent reason.
+ - Contents of the document are found by following the Attachment URL.
+
+ - See more information on the
Binary resource to determine what Authorization scopes are required, and how to set the Accept header when downloading document contents.
+
+
Authorization Types
@@ -535,12 +553,6 @@ Response
]
}
-Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
-
-Errors
-
-The common errors and OperationOutcomes may be returned.
-
Create
Create new documents. Currently limited to unstructured clinical notes or documentation. For example, a document with display formatting or styling can be written, but a CCD cannot.
@@ -551,8 +563,11 @@ Create
Implementation Notes
- - The modifier elements implicitRules, modifierExtension and relatesTo are not supported and will be rejected if present.
- - Currently only XHTML formatted documents are supported. You can validate your document using any available strict XHTML 1.0 validator (eg: w3 validator or this html5 validator).
+ - Currently only XHTML formatted documents are supported.
+
+ - You can validate your document using any available strict XHTML 1.0 validator (eg: W3C Markup Validation Service or Nu Html Checker).
+
+
Authorization Types
@@ -1252,50 +1267,20 @@ Response
location: https://fhir-ehr-code.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference/5789254
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: 9c7510c0-0bb5-4148-b37e-51a774c4091b
+x-request-id: 11111111-1111-1111-1111-111111111111
x-xss-protection: 1; mode=block
-Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
-
-Errors
-
-The common errors and OperationOutcomes may be returned. Additional OperationOutcomes may be returned in the following scenarios:
-
-
-
-
- HTTP Status
- Cause
- Severity
- Code
-
-
-
-
- 422
- Body contained relatesTo
- error
- not-supported
-
-
-
-
-Operation: docref
+Operation: $docref
Argonaut operation for querying DocumentReferences for the supplied parameters:
GET /DocumentReference/$docref?:parameters
-Implementation Notes
-
-
- - The DocumentReference.relatesTo modifier element is not supported and will not be returned.
-
-
Authorization Types
@@ -1414,40 +1399,52 @@ Parameters
patientY
- referenceA reference to the patient whose document references are required. Example: 12345
+ Yes
+ referenceA reference to the patient whose document references are required. Example: patient=12345
typeY
- tokenThe document reference type, can be a list of comma separated values. Example: http://loinc.org|34133-9
+ Yes
+ tokenThe document reference type. Example: type=http://loinc.org\|34133-9
startN
- dateThe start of the date range from which document reference records should be included. If not provided, then all records from the beginning of time are included. Example: 2014-09-24T12:00:00.000Z
+ No
+ dateThe start of the date range from which document reference records should be included. Example: start=2014-09-24T12:00:00.000Z
endN
- dateThe end of the date range till which document reference records should be included. If not provided, then all records up to the current date are included. Example: 2016-09-24T12:00:00.000Z
+ No
+ dateThe end of the date range till which document reference records should be included. Example: end=2016-09-24T12:00:00.000Z
-Notes:
+Implementation Notes
- - The
type parameter must include both a system and a code. (e.g. &type=http://loinc.org|34133-9)
- - The
start and end parameters must be valid dateTimes with a time component. They must have prefixes of eq or nothing.
+ - The
type parameter:
+
+ - It must include both a system and a code. (e.g.
&type=http://loinc.org\|34133-9)
+ - It may be a single system and code, or a comma-separated list.
+
+
+ - The
start and end parameters:
+
+ - They must be valid dateTimes with a time component.
+ - They must have prefixes of
eq or nothing.
+ - If
start is not provided, then all previous records up to the end date are included.
+ - If
end is not provided, then all records between the start date and the current date are included.
+
+
Headers
@@ -1517,12 +1514,6 @@ Response
]
}Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
- -The common errors and OperationOutcomes may be returned.
-The Immunization resource includes the view of current and historical administration of vaccinations to a patient in all healthcare settings. This resource contains the functionality to query a patient’s immunization history.
+The Immunization resource is intended to cover the recording of current and historical administration of vaccines to patients across all healthcare disciplines, in all care settings, and all regions. This resource contains the functionality to query a patient’s immunization history. Detailed administration records may be found in the MedicationAdministration resource, while this Immunization resource would represent the known vaccination history regardless of where the administration itself was done.
Detailed administration records may be found in MedicationAdministration, while the Immunization resource would represent the known vaccination history regardless of where the administration itself was done.
+An immunization reaction may indicate an allergy or intolerance. If so, a separate AllergyIntolerance resource instance must be created.
An immunization reaction may indicate an allergy or intolerance. If so, a separate AllergyIntolerance resource instance should be created as well.
+Note that while the terms immunization and vaccination are not clinically identical, for the purposes of FHIR resources, the terms are used synonymously.
The following fields are returned if valued:
@@ -117,6 +119,12 @@Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
+ +The common errors and OperationOutcomes may be returned.
+| Name | -Required? | +Required | Type | Description | |
|---|---|---|---|---|---|
_id |
- This, or patient
- |
+ Conditionally | token |
- The logical resource id associated with the resource. | +The logical resource ID associated with the resource. This parameter is required if the patient parameter is not used. Example: 12345
+ |
patient |
- This, or _id
- |
+ Conditionally | reference |
- The patient for the vaccination record. Example: 12345
+ | The patient for the vaccination record(s). This parameter is required if the _id parameter is not used. Example: 12345
|
date |
- N | +No | date |
- Date range into which the immunization administration date falls. Must be prefixed by ‘ge’ or ‘le’. | +Date range for the immunization administration(s). Example: date=ge2020-01-01T08:00:00.000Z&date=le2020-01-31T17:00:00.000Z
+ |
Notes:
+Implementation Notes
date parameter value should be prefixed once by ‘ge’ representing the earliest date, and once by ‘le’ representing the latest date. Examples: date=ge2015-01-01&date=le2016-01-01, date=ge2015-01-01, date=le2016-01-01
+ _id parameter:
+ _id=1234 or _id=1234,5678
patient parameter:
+ date parameter:
+ date occurrence:
+ le or ge prefix to search for vaccination record(s) administrations earlier or later than the given date.time component is optional.date occurences:
+ le and ge prefixes to search for vaccination record(s) within a specific range.time component is optional, but must be consistent. If one date has a time component, so must the other.Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
+The common errors and OperationOutcomes may be returned.
- -List an individual Immunization by its id:
+List an individual immunization by the associated ID:
GET /Immunization/:id
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
- -The common errors and OperationOutcomes may be returned.
-_revinclude is provided in a request to the closed endpoint, the OAuth2 token must include the user/Provenance.read scope. Currently patient/Provenance.read is not supported and hence _revinclude cannot be utilised for patient persona._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.Status: 200 OK{
@@ -571,20 +571,20 @@ Patient Authorization Request
Response
-
+
-
+
Status: 200 OK
{
diff --git a/millennium/r4/base/individuals/patient/index.html b/millennium/r4/base/individuals/patient/index.html
index 1f62e5d9b..baa2e436b 100644
--- a/millennium/r4/base/individuals/patient/index.html
+++ b/millennium/r4/base/individuals/patient/index.html
@@ -662,7 +662,7 @@ Parameters
The _revinclude parameter may be provided with any required search param. Example: _id=629928&_revinclude=Provenance:target
- When _revinclude is provided in a request to the closed endpoint, the OAuth2 token must include the user/Provenance.read scope. Currently patient/Provenance.read is not supported and hence _revinclude cannot be utilised for patient persona.
+ 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.
FHIR does not return the SSN. It can be passed in as a query parameter but it won’t come back in the JSON response.
diff --git a/millennium/r4/base/management/encounter/index.html b/millennium/r4/base/management/encounter/index.html
index 4bf1c70fe..033f3e92f 100644
--- a/millennium/r4/base/management/encounter/index.html
+++ b/millennium/r4/base/management/encounter/index.html
@@ -1312,7 +1312,7 @@ Parameters
- If _revinclude is provided in a request to the closed endpoint, the OAuth2 token must include the user/Provenance.read scope. Currently, patient/Provenance.read is not supported and hence _revinclude cannot be utilized for patient persona.
+ When _revinclude is provided in a request to the closed endpoint, the OAuth2 token must include the scope corresponding to the Authorization Type, such as user/Provenance.read, patient/Provenance.read or system/Provenance.read.
_count and status must be provided with patient
diff --git a/millennium/r4/base/workflow/appointment/index.html b/millennium/r4/base/workflow/appointment/index.html
index 97ce49428..f721adf29 100644
--- a/millennium/r4/base/workflow/appointment/index.html
+++ b/millennium/r4/base/workflow/appointment/index.html
@@ -110,10 +110,12 @@ Appointment
Example - Update reasonCode
Example - Add cancelationReason
Example - Replace Slot
+ Example - Add rescheduleReason
Example - Add Video Visit Links
Example - Replace Video Visit Links
Example - Update Participant Status
- Example - Update Action Comment
+ Example - Update Action Comment with Replace Slot
+ Example - Update Action Comment with Replace Status
Errors
@@ -174,7 +176,7 @@ Overview
Comment
Patient Instruction
Requested period
- Extensions including action-comment, group-appointment-id, is-cancelable, and is-reschedulable
+ Extensions including action-comment, group-appointment-id, is-cancelable, is-reschedulable, and reschedule-reason
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
@@ -459,6 +461,7 @@ Extensions
Group Appointment Id
Is Cancelable
Is Reschedulable
+ Reschedule Reason
Custom Extensions
@@ -494,6 +497,11 @@ Custom Extensions
booleanIndication of whether the Appointment can be rescheduled or not.
+
+ reschedule-reasonCodeableConceptThe coded reason for the appointment being rescheduled.
+
@@ -752,7 +760,11 @@ Response
"display": "Smart II, Nancy"
},
"required": "required",
- "status": "accepted"
+ "status": "accepted",
+ "period": {
+ "start": "2023-07-26T14:00:00Z",
+ "end": "2023-07-26T15:00:00Z"
+ }
}
],
"requestedPeriod": [
@@ -918,7 +930,11 @@ Response
"display": "Smart II, Nancy"
},
"required": "required",
- "status": "accepted"
+ "status": "accepted",
+ "period": {
+ "start": "2023-07-26T14:00:00Z",
+ "end": "2023-07-26T15:00:00Z"
+ }
}
],
"requestedPeriod": [
@@ -1076,7 +1092,11 @@ Response
"display": "SMART, NANCY"
},
"required": "required",
- "status": "accepted"
+ "status": "accepted",
+ "period": {
+ "start": "2023-07-26T14:00:00Z",
+ "end": "2023-07-26T15:00:00Z"
+ }
},
{
"type": [
@@ -2507,6 +2527,7 @@ Patch Operations
- When present, this patch operation must be accompanied by add cancellation reason and replace status patch operation when updating the status to
cancelled
+ - When present, this patch operation must be accompanied by replace slot when rescheduling the appointment.
- Only one value may be provided in the value array
@@ -2551,6 +2572,56 @@ Patch Operations
- When present, this patch operation must be accompanied by the replace Slot patch operation
+
+
+
+
+
+
+
+
+
+
+
+ /extension
+
+
+
+ add
+
+Extension
+
+
+
+
+
+ - Description
+ - The coded reason for the appointment being rescheduled
+
+
+ - Example
+ {
+ "op": "add",
+ "path": "/extension",
+ "value": {
+ "coding": [
+ {
+ "system": "http://terminology.hl7.org/CodeSystem/appointment-cancellation-reason",
+ "code": "oth-err"
+ }
+ ]
+ }
+}
+
+
+
+
+ - Notes
+ -
+
+ - When present, this patch operation must be accompanied by replace slot operation
+ - Only one value may be provided in the value array
+
@@ -2769,15 +2840,69 @@ Response
X-Request-Id: 26ca6d46-bf47-430b-b92f-bf687b80bfbf
-Example - Add Video Visit Links
+Example - Add rescheduleReason
Request
-PATCH https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Appointment/4627745
+PATCH https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Appointment/4817517
Body
+[
+ {
+ "op": "replace",
+ "path": "/slot",
+ "value": [
+ {
+ "reference": "Slot/2582093771-22784981-63303788-60"
+ }
+ ]
+ },
+ {
+ "op": "add",
+ "path": "/extension",
+ "value": [
+ {
+ "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/reschedule-reason",
+ "valueCodeableConcept": {
+ "coding": [
+ {
+ "system": "http://terminology.hl7.org/CodeSystem/appointment-cancellation-reason",
+ "code": "oth-err"
+ }
+ ]
+ }
+ }
+ ]
+ }
+]
+
+Response
+
+Status: 200 OK
+
+
+Cache-Control: no-cache
+Content-Length: 0
+Content-Type: text/html
+Date: Tue, 26 Mar 2019 15:42:29 GMT
+Etag: W/"1"
+Last-Modified: Tue, 26 Mar 2019 15:42:27 GMT
+Vary: Origin
+opc-request-id: /95685D1463E5BE27E66427BBDA8725DE/BD2E22EED59A7AD48B938357F8CF72E1
+X-Request-Id: 26ca6d46-bf47-430b-b92f-bf687b80bfbf
+
+
+Example - Add Video Visit Links
+
+Request
+
+PATCH https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Appointment/4627745
+
+
+Body
+
[
{
"op": "add",
@@ -2801,7 +2926,7 @@ Body
}
]
-Response
+Response
Status: 200 OK
@@ -2819,12 +2944,12 @@ Response
Example - Replace Video Visit Links
-Request
+Request
PATCH https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Appointment/4627745
-Body
+Body
[
{
@@ -2849,7 +2974,7 @@ Body
}
]
-Response
+Response
Status: 200 OK
@@ -2867,12 +2992,12 @@ Response
Example - Update Participant Status
-Request
+Request
PATCH https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Appointment/4817517
-Body
+Body
[
{
@@ -2882,7 +3007,7 @@ Body
}
]
-Response
+Response
Status: 200 OK
@@ -2898,14 +3023,61 @@ Response
X-Request-Id: 26ca6d46-bf47-430b-b92f-bf687b80bfbf
-Example - Update Action Comment
+Example - Update Action Comment with Replace Slot
-Request
+Request
PATCH https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Appointment/4817517
-Body
+Body
+
+[
+ {
+ "op": "replace",
+ "path": "/slot",
+ "value": [
+ {
+ "reference": "Slot/2592955413-2581440805-96118899-0"
+ }
+ ]
+ },
+ {
+ "op": "replace",
+ "path": "/extension",
+ "value": [
+ {
+ "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/action-comment",
+ "valueString": "Rescheduling Appointment"
+ }
+ ]
+ }
+]
+
+Response
+
+Status: 200 OK
+
+
+Cache-Control: no-cache
+Content-Length: 0
+Content-Type: text/html
+Date: Fri, 11 Aug 2023 15:42:29 GMT
+Etag: W/"10"
+Last-Modified: Fri, 11 Aug 2023 15:42:29 GMT
+Vary: Origin
+opc-request-id: /95685D1463E5BE27E66427BBDA8725DE/BD2E22EED59A7AD48B938357F8CF72E1
+X-Request-Id: 26ca6d46-bf47-430b-b92f-bf687b80bfbf
+
+
+Example - Update Action Comment with Replace Status
+
+Request
+
+PATCH https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Appointment/4817517
+
+
+Body
[
{
@@ -2937,7 +3109,7 @@ Body
}
]
-Response
+Response
Status: 200 OK
diff --git a/millennium/r4/clinical/care-provision/care-plan/index.html b/millennium/r4/clinical/care-provision/care-plan/index.html
index df5ab4fbb..881ea0d04 100644
--- a/millennium/r4/clinical/care-provision/care-plan/index.html
+++ b/millennium/r4/clinical/care-provision/care-plan/index.html
@@ -380,7 +380,7 @@ Parameters
- When _revinclude is provided in a request to the closed endpoint, the OAuth2 token must include the user/Provenance.read scope. Currently patient/Provenance.read is not supported and hence _revinclude cannot be utilized for patient persona.
+ When _revinclude is provided in a request to the closed endpoint, the OAuth2 token must include the scope corresponding to the Authorization Type, such as user/Provenance.read, patient/Provenance.read or system/Provenance.read.
Headers
diff --git a/millennium/r4/clinical/care-provision/care-team/index.html b/millennium/r4/clinical/care-provision/care-team/index.html
index a7d3a7c27..346448f6c 100644
--- a/millennium/r4/clinical/care-provision/care-team/index.html
+++ b/millennium/r4/clinical/care-provision/care-team/index.html
@@ -379,7 +379,7 @@ Parameters
- When _revinclude is provided in a request to the closed endpoint, the OAuth2 token must include the user/Provenance.read scope. Currently patient/Provenance.read is not supported and hence _revinclude cannot be utilized for patient persona.
+ When _revinclude is provided in a request to the closed endpoint, the OAuth2 token must include the scope corresponding to the Authorization Type, such as user/Provenance.read, patient/Provenance.read or system/Provenance.read.
Headers
diff --git a/millennium/r4/clinical/care-provision/goal/index.html b/millennium/r4/clinical/care-provision/goal/index.html
index ae6d3d9ae..add33e000 100644
--- a/millennium/r4/clinical/care-provision/goal/index.html
+++ b/millennium/r4/clinical/care-provision/goal/index.html
@@ -345,7 +345,7 @@ Parameters
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 user/Provenance.read scope. Currently patient/Provenance.read is not supported and hence _revinclude cannot be utilised for patient persona.
+ 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.
diff --git a/millennium/r4/clinical/diagnostics/diagnostic-report/index.html b/millennium/r4/clinical/diagnostics/diagnostic-report/index.html
index 5b944af39..6903c952e 100644
--- a/millennium/r4/clinical/diagnostics/diagnostic-report/index.html
+++ b/millennium/r4/clinical/diagnostics/diagnostic-report/index.html
@@ -490,7 +490,7 @@ Parameters
- When _revinclude is provided in a request to the closed endpoint, the OAuth2 token must include the user/Provenance.read scope. Currently patient/Provenance.read is not supported and hence _revinclude cannot be utilised for patient persona.
+ 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 common errors and OperationOutcomes may be returned.
diff --git a/millennium/r4/clinical/medications/immunization/index.html b/millennium/r4/clinical/medications/immunization/index.html
index 8f4cd4c5d..5d339a352 100644
--- a/millennium/r4/clinical/medications/immunization/index.html
+++ b/millennium/r4/clinical/medications/immunization/index.html
@@ -68,7 +68,11 @@ Millennium
Immunization
- - Overview
+ -
+Overview
+ - Errors
+
+
- Terminology Bindings
-
Search
@@ -78,15 +82,13 @@ Immunization
- Example
- Example with RevInclude
- Authorization Types
- - Errors
-
-Retrieve by id
-
@@ -95,7 +97,6 @@
Immunization
- Headers
- Body Fields
- Example
- - Errors
@@ -104,22 +105,21 @@ Immunization
Headers
Body fields
Example
- Errors
Overview
-The Immunization resource includes the view of current and historical administration of vaccinations to a patient in all healthcare settings. This resource contains the functionality to query a patient’s immunization history.
+The Immunization resource is intended to cover the recording of current and historical administration of vaccines to patients across all healthcare disciplines, in all care settings, and all regions. This resource contains the functionality to query a patient’s immunization history. You can find detailed administration records in the MedicationAdministration resource, while this Immunization resource represents the known vaccination history regardless of where the administration itself was done.
-Detailed administration records may be found in MedicationAdministration, while the Immunization resource would represent the known vaccination history regardless of where the administration itself was done.
+An immunization reaction may indicate an allergy or intolerance. If so, create a separate AllergyIntolerance resource instance as well.
-An immunization reaction may indicate an allergy or intolerance. If so, a separate AllergyIntolerance resource instance should be created as well.
+Note that while the terms immunization and vaccination are not clinically identical, for the purposes of FHIR resources, the terms are used synonymously.
-
-
The following HL7® FHIR® US Core Implementation Guide STU 4.0.0 Profiles are supported by this resource:
+ This resource supports the following HL7 FHIR US Core Implementation Guide STU 4.0.0 profiles:
- US Core Immunization Profile
@@ -130,59 +130,60 @@ Overview
The following fields are returned if valued:
- - Id
+ - ID
- Immunization Record Identifier
- - Status
- - Status reason
- - Vaccine administered
- - Patient
- - Patient encounter
- - Occurrence DateTime
- - Primary Source
- - Report Origin
- - Location
- - Vaccine manufacturer
- - Vaccine lot number
- - Vaccine expiration date
- - Vaccine administration site
- - Vaccine administration route
- - Dosage administered
+ - Status
+ - Status reason
+ - Vaccine administered
+ - Patient
+ - Patient encounter
+ - Occurrence DateTime
+ - Primary Source
+ - Report Origin
+ - Location
+ - Vaccine manufacturer
+ - Vaccine lot number
+ - Vaccine expiration date
+ - Vaccine administration site
+ - Vaccine administration route
+ - Dosage administered
-
-Performer
+Performer
-
-Note
+Note (follows Annotation structure)
-
-Author reference
-
- -
-Reference (Practitioner)
-
-
- - Time
- - Text
+Reference (Practitioner)
+ - Time
+ - Text
-Protocol applied
+Protocol applied
+Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
+
+Errors
+
+The common errors and OperationOutcomes may be returned.
+
Terminology Bindings
@@ -214,7 +215,7 @@ Terminology Bindings
- Details: Immunization Status Reason
+
Details: Immunization Status Reason
System: http://terminology.hl7.org/CodeSystem/v3-ActReason
@@ -275,7 +276,7 @@
Terminology Bindings
- Details: CVX
+
Details: CVX
System: http://hl7.org/fhir/sid/cvx
@@ -291,7 +292,7 @@
Terminology Bindings
- Details: NDC
+
Details: NDC
System: http://hl7.org/fhir/sid/ndc
@@ -352,7 +353,7 @@
Terminology Bindings
- Details: Immunization Report Origin
+
Details: Immunization Report Origin
System: http://terminology.hl7.org/CodeSystem/immunization-origin
@@ -412,7 +413,7 @@
Terminology Bindings
- Details: SNOMED CT
+
Details: SNOMED CT
System: http://snomed.info/sct
@@ -469,7 +470,7 @@
Terminology Bindings
- Details: SNOMED CT
+
Details: SNOMED CT
System: http://snomed.info/sct
@@ -532,7 +533,7 @@
Terminology Bindings
- Details: CVX
+
Details: CVX
System: http://hl7.org/fhir/sid/cvx
@@ -548,7 +549,7 @@
Terminology Bindings
- Details: SNOMED CT
+
Details: SNOMED CT
System: http://snomed.info/sct
@@ -587,7 +588,7 @@
Terminology Bindings
Search
-Search for Immunizations that meet supplied query parameters:
+Search for immunizations that meet supplied query parameters:
GET /Immunization?:parameters
@@ -612,61 +613,86 @@ Parameters
_idThis, or patient
-
+ Conditionally
tokenThe logical resource id associated with the resource.
+ The logical resource ID associated with the resource. This parameter is required if the patient parameter is not used. Example: M12345
+
patientThis, or _id
-
+ Conditionally
referenceThe patient for the vaccination record. Example: 12345
+ The patient for the vaccination record. This parameter is required if the _id parameter is not used. Example: 12345
dateNo
dateDate range into which the immunization administration date falls. Must be prefixed by ‘ge’ or ‘le’.
+ The date range for the immunization administration or administrations. Example: date=ge2020-01-01T08:00:00.000Z&date=le2020-01-31T17:00:00.000Z
+
- _revincludetarget-diseaseNo
tokenProvenance resource entries to be returned as part of the bundle. Example:_revinclude=Provenance:target
+ The target disease that the dose is being administered against. Example: http://hl7.org/fhir/sid/cvx|213
+
- target-disease_revincludeNo
tokenThe target disease the dose is being administered against. Example: http://hl7.org/fhir/sid/cvx|213
-
+ The Provenance resource entries that are returned as part of the bundle.
-Notes:
+Implementation Notes
- - The
date parameter may be provided:
+ - When searching with the
_id parameter:
- - 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)
+ - It can be provided with either a single reference, or a comma-separated list of references. Example:
_id=M1234 or _id=M1234,M5678
+
+ - It must not be provided with any other parameters, except with
_revinclude as indicated below.
- - The
_revinclude parameter may be provided once with the value Provenance:target. Example: _revinclude=Provenance:target
+ - When searching with the
patient parameter:
+
+ - It can be provided with only a single reference; a comma-separated list is not supported.
+
+
+ - When searching with the
date parameter:
+
+ - For a single
date occurrence:
+
+ - It must be provided with either the
le or ge prefix to search for vaccination record administrations earlier or later than the given date.
+ - The time component is optional.
+
+
+ - For two
date occurrences:
+
+ - It must be provided with
le and ge prefixes to search for vaccination records within a specific range.
+ - The time component is optional, but must be consistent. If one date has a time component, so must the other.
+
+
+
+
+ - When searching with the
target-disease parameter:
+
+ - Searching by Cerner Millennium proprietary codes is not supported.
+
+
+ - When searching with the
_revinclude parameter:
+
+ - It can be provided once with the
Provenance:target value. Example: _revinclude=Provenance:target
- - The
_revinclude parameter may be provided in combination with the _id/patient parameter. Example: _id=M17255835,M17255827&_revinclude=Provenance:target
+ - It can be provided with the
_id or patient parameter. Example: _id=M17255835&_revinclude=Provenance:target
- - When
_revinclude is provided in a request to a closed endpoint, the OAuth2 token must include the user/Provenance.read scope.
- - Currently the
patient/Provenance.read scope is not supported and hence _revinclude cannot be utilised for patient persona.
- - The
target-disease parameter
-
- - Searching by Millennium proprietary codes is not supported
+ - 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.
Headers
@@ -862,8 +888,6 @@ Response
]
}
-Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
-
Example with RevInclude
Authorization Types
@@ -1174,7 +1198,6 @@ Response
}
]
}
-Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Patient Authorization Request
@@ -1362,15 +1385,9 @@ Response
]
}
-Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
-
-Errors
-
-The common errors and OperationOutcomes may be returned.
-
-Retrieve by id
+Retrieve by ID
-List an individual Immunization by its id:
+List an individual immunization by the associated ID:
GET /Immunization/:id
@@ -1488,8 +1505,6 @@ Response
]
}
-Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
-
Patient Authorization Request For Completed Status
GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Immunization/M197197986
@@ -1566,8 +1581,6 @@ Response
}
}
-Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
-
Patient Authorization Request For Entered in Error Status
GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Immunization/M211860902
@@ -1613,9 +1626,7 @@ Response
}
}
-Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
-
-Patient Authorization Request For Not done Status
+Patient Authorization Request For Not Done Status
GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Immunization/HM178147794
@@ -1664,15 +1675,9 @@ Response
"primarySource": true
}
-Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
-
-Errors
-
-The common errors and OperationOutcomes may be returned.
-
Create
-Create a new Immunization.
+Create a new immunization.
POST /Immunization
@@ -1704,7 +1709,7 @@ Body Fields
- resourceType
+ resourceType
@@ -1939,7 +1944,7 @@ Body Fields
- Notes
-
- - encounter is required field to create charted immunizations
+ - encounter is required field to create charted immunizations.
- encounter is not a required field to create staged immunizations.
@@ -2025,7 +2030,7 @@ Body Fields
- Notes
- - Should not be supplied when primarySource is set to true
+ - Should not be supplied when primarySource is set to true.
@@ -2565,18 +2570,15 @@ Response
Last-Modified: Sun, 30 Jun 2019 10:35:00 GMT
Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Immunization/147391087
Vary: Origin
-X-Request-Id: 1638e30e497b93ff4383b2ff0eaeea68
+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.
-Errors
-
-The common errors and OperationOutcomes may be returned.
-
Update
-Update an Immunization.
+Update an immunization.
PUT /Immunization/:id
@@ -2609,7 +2611,7 @@ Body fields
- resourceType
+ resourceType
@@ -2957,7 +2959,7 @@ Body fields
Notes
- - Should not be supplied when primarySource is set to true
+ - Should not be supplied when primarySource is set to true.
@@ -3492,15 +3494,11 @@ Response
Etag: W/"2"
Last-Modified: Sun, 30 Jun 2019 10:40:00 GMT
Vary: Origin
-X-Request-Id: 1638e30e497b93ff4383b2ff0eaeea91
+X-Request-Id: b72617f9-1a52-46ca-bb52-b0b3f976f9fb
The ETag response header indicates the current If-Match version to use on subsequent updates.
-Errors
-
-The common errors and OperationOutcomes may be returned.
-
diff --git a/millennium/r4/clinical/medications/medication-request/index.html b/millennium/r4/clinical/medications/medication-request/index.html
index 781441ce1..89a318070 100644
--- a/millennium/r4/clinical/medications/medication-request/index.html
+++ b/millennium/r4/clinical/medications/medication-request/index.html
@@ -1151,8 +1151,7 @@ Parameters
_revinclude parameter may be provided with the _id/patient/subject/account parameter. Example: _id=74771957,4732066&_revinclude=Provenance:target
-
-_revinclude is provided in a request to the closed endpoint, the OAuth2 token must include the user/Provenance.read scope. Currently patient/Provenance.read is not supported and hence _revinclude cannot be utilised for patient persona.
+ 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)
diff --git a/millennium/r4/clinical/summary/allergy-intolerance/index.html b/millennium/r4/clinical/summary/allergy-intolerance/index.html
index 2fa179ba7..023900b81 100644
--- a/millennium/r4/clinical/summary/allergy-intolerance/index.html
+++ b/millennium/r4/clinical/summary/allergy-intolerance/index.html
@@ -675,7 +675,7 @@ Parameters
- When _revinclude is provided in a request to the closed endpoint, the OAuth2 token must include the user/Provenance.read scope. Currently patient/Provenance.read is not supported and hence _revinclude cannot be utilised for patient persona.
+ 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.
Headers
diff --git a/millennium/r4/clinical/summary/condition/index.html b/millennium/r4/clinical/summary/condition/index.html
index 0c14d0124..f60fe60ea 100644
--- a/millennium/r4/clinical/summary/condition/index.html
+++ b/millennium/r4/clinical/summary/condition/index.html
@@ -640,7 +640,7 @@ Parameters
- When _revinclude is provided in a request to the closed endpoint, the OAuth2 token must include the user/Provenance.read scope. Currently patient/Provenance.read is not supported and hence _revinclude cannot be utilised for patient persona.
+ 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.
When encounter is provided, encounter-diagnosis for the matched encounter/s and all problem-list-item conditions of the patient will be returned. No HealthConcerns are returned.
diff --git a/millennium/r4/clinical/summary/family-member-history/index.html b/millennium/r4/clinical/summary/family-member-history/index.html
index da022535f..f5fc87d61 100644
--- a/millennium/r4/clinical/summary/family-member-history/index.html
+++ b/millennium/r4/clinical/summary/family-member-history/index.html
@@ -70,12 +70,10 @@ FamilyMemberHistory
- Overview
- Terminology Bindings
- - Modifier Extensions
- - Extensions
-
Custom Modifier Extensions and Extensions
-
@@ -88,7 +86,7 @@
FamilyMemberHistory
-Retrieve by id
+Retrieve by ID
- Authorization Types
- Headers
- Example
@@ -117,16 +115,16 @@ FamilyMemberHistory
Overview
-The FamilyMemberHistory resource represents family history for a given patient. It may provide a list of conditions associated to a patient’s family member or the absence of a condition on a given individual. In other cases, the resource may indicate that there is no relevant family history, no significant history for a given relative, or that the patient’s family history is unknown or unable to obtain.
+The FamilyMemberHistory resource represents family history for a given patient. The resource may provide a list of conditions associated with a patient’s family member or the absence of a condition on a given individual. In other cases, the resource may indicate that no relevant family history exists, no significant history for a given relative exists, or the patient’s family history is unknown or unobtainable.
-The resource should be leveraged as a snapshot in time and new data should be consistently retrieved through the API rather than stored within an application. There may be instances where a relative had an associated condition removed from the patient’s chart which would then no longer be exposed on a subsequent transaction. It is crucial that the data be refreshed with every interaction.
+The resource should be used as a snapshot in time and new information should be consistently retrieved through the API rather than stored in an application. In some instances, a relative could have an associated condition removed from the patient’s chart, which would then no longer be exposed on a subsequent transaction. Information must be refreshed with every interaction.
-It is recommended that an update to FamilyMemberHistory contain all relevant data that previously existed on the resource to ensure that data remains populated in the patient’s chart (e.g., FamilyMemberHistory.sex, FamilyMemberHistory.bornDate, FamilyMemberHistory.condition.onsetDate, etc.). The absence of this optional information may result in the removal of data from the patient’s chart.
+Oracle Cerner recommends that an update to FamilyMemberHistory contains all relevant information that previously existed on the resource to ensure that information remains populated in the patient’s chart (for example, FamilyMemberHistory.sex, FamilyMemberHistory.bornDate, FamilyMemberHistory.condition.onsetDate, and so on). The absence of this optional information may remove the existing information from the patient’s chart.
The following fields are returned if valued:
- - Id
+ - ID
- Status
- Data Absent Reason
- Patient
@@ -139,39 +137,39 @@ Overview
-
Deceased
-
-Extension
+Extension
-
Condition
@@ -297,7 +295,7 @@
Terminology Bindings
-
-
Details: V3 Value SetFamilyMember
+
Details: V3 Value SetFamilyMember
System: http://terminology.hl7.org/CodeSystem/v3-RoleCode
@@ -588,7 +586,7 @@
Terminology Bindings
- FamilyMemberHistory.condition.modifierExension(condition-result)
+ FamilyMemberHistory.condition.modifierExension(condition-result)
@@ -629,7 +627,7 @@ Terminology Bindings
- FamilyMemberHistory.condition.modifierExension(condition-lifecycle-status)
+ FamilyMemberHistory.condition.modifierExension(condition-lifecycle-status)
@@ -766,27 +764,11 @@ Terminology Bindings
-Modifier Extensions
-
-
-
-Extensions
-
-
-
Custom Modifier Extensions and Extensions
-URLs for custom extensions are defined as https://fhir-ehr.cerner.com/r4/StructureDefinition/{id}
+URLs for custom extensions are defined as https://fhir-ehr.cerner.com/r4/StructureDefinition/{ID}
-Modifier Extensions
+Modifier Extensions
@@ -799,18 +781,18 @@ Modifier Extensions
condition-resultCodeableConcpetIndication of the presence (positive) or absence (negative) of a given condition.
+ CodeableConceptIndicates the presence (positive) or absence (negative) of a given condition.
condition-lifecycle-statusCodeableConcpetIndication of whether a condition is active, inactive, resolved, etc.
+ CodeableConceptIndicates whether a condition is active, inactive, resolved, and so on.
-Extensions
+Extensions
@@ -824,32 +806,37 @@ Extensions
patient-adoptedBooleanIndication of whether a patient is adopted. Only returned when true.
+ Indicates whether a patient is adopted. Only returned when true.
precisionCodeableConcpetIndication of the precision of a given value.
+ CodeableConceptIndicates the precision of a given value.
condition-courseCodeableConcpetIndication of a condition’s progress since diagnosis.
+ CodeableConceptIndicates a condition’s progress since diagnosis.
+
+
+ familymemberhistory-severityCodeableConceptIndicates the seriousness or health impact of the family member’s condition.
Search
-Search for FamilyMemberHistories that meet supplied query parameters:
+Search for the family member histories that meet the supplied query parameters.
GET /FamilyMemberHistory?:parameters
-Implementation Notes
+Notes
- - FamilyMemberHistories with the ‘FAMMEMB’ relation are sometimes system generated.
+ - Family member histories with the ‘FAMMEMB’ relation are sometimes system generated.
Authorization Types
@@ -864,7 +851,7 @@ Parameters
Name
- Required?
+ Required
Type
Description
@@ -872,30 +859,26 @@ Parameters
_idThis or patient
+ Conditionally
tokenThe logical resource id associated with the resource.
+ The logical resource ID associated with the resource. This parameter is required if patient is not used.
patientThis or _id
+ Conditionally
referenceThe identity of a subject to list family member history items for. Example: 12345
+ The identity of a subject to list family member history items for. This parameter is required if _id_ is not used. Example: 12345
statusNo
tokenThe status of the record of the family history of a specific family member.
+ The record status for a specific family member. This parameter is only provided when the patient search parameter is used.
-Implementation Notes
-
-status may only be provided when the patient search parameter is provided
-
Headers
Accept: application/fhir+json
@@ -1116,14 +1099,14 @@ Errors
The common errors and OperationOutcomes may be returned.
-Retrieve by id
+Retrieve by ID
-List an individual FamilyMemberHistory by its id:
+List an individual family member history by its ID.
-GET /FamilyMemberHistory/:id
+GET /FamilyMemberHistory/:ID
-Implementation Notes
+Notes
- FamilyMemberHistories with the ‘FAMMEMB’ relation are sometimes system generated.
@@ -1320,16 +1303,16 @@ Errors
Create
-Create a new FamilyMemberHistory.
+Create a new family member history.
POST /FamilyMemberHistory
-Implementation Notes
+Notes
- - Only the body fields mentioned below are supported. Unsupported fields will be ignored.
- - Conditions cannot be added while creating the FamilyMemberHistory.
+ - Only the body fields below are supported. Unsupported fields are ignored.
+ - Conditions cannot be added while creating the family member history.
Authorization Types
@@ -1831,16 +1814,16 @@ Errors
Update
-Update a FamilyMemberHistory.
+Update a family member history.
-PUT /FamilyMemberHistory/:id
+PUT /FamilyMemberHistory/:ID
-Implementation Notes
+Notes
- - Conditions can be removed from a FamilyMemberHistory by setting the ‘condition-lifecycle-status’ modifierExtension to ‘entered-in-error’ with system ‘http://terminology.hl7.org/CodeSystem/condition-ver-status’. Only existing conditions can be removed; condition id must be provided.
- - An update should only be performed directly after a FamilyMemberHistory is retrieved. If a condition.id is returned on the get operation, it MUST be provided on the subsequent update and must match the condition.id returned from the get.
+ - Conditions can be removed from a family member history if you set the ‘condition-lifecycle-status’ modifierExtension to ‘entered-in-error’ with system ‘http://terminology.hl7.org/CodeSystem/condition-ver-status’. Only existing conditions can be removed and condition ID must be provided.
+ - An update should only be performed directly after a family member history is retrieved. If a condition ID is returned for the
GET request, the ID must be provided on the subsequent update and must match the condition ID returned from the GET.
Authorization Types
@@ -1883,7 +1866,7 @@ Body fields
- Description
- - The logical id of the resource to update.
+ - The logical ID of the resource to update.
- Example
@@ -2344,7 +2327,7 @@ Body fields
- condition
+ condition
@@ -2608,7 +2591,7 @@ Body fields
- condition.modifierExension(condition-result)
+ condition.modifierExension(condition-result)
@@ -2655,7 +2638,7 @@ Body fields
- condition.modifierExension(condition-lifecycle-status)
+ condition.modifierExension(condition-lifecycle-status)
diff --git a/millennium/r4/clinical/summary/procedure/index.html b/millennium/r4/clinical/summary/procedure/index.html
index 5df46dd91..a0202c3e0 100644
--- a/millennium/r4/clinical/summary/procedure/index.html
+++ b/millennium/r4/clinical/summary/procedure/index.html
@@ -68,7 +68,11 @@ Millennium
Procedure
- - Overview
+ -
+Overview
+ - Errors
+
+
- Terminology Bindings
-
Search
@@ -76,17 +80,15 @@ Procedure
- Parameters
- Headers
- Example
- - Example with RevInclude
+ - Example With RevInclude
- Authorization Types
- - Errors
-
-Retrieve by id
-
@@ -95,19 +97,18 @@
Procedure
- Headers
- Body Fields
- Example
- - Errors
Overview
-The Procedure resource returns medical and surgical procedures performed on or for a patient during their lifetime. Historical procedures, as well as procedures recorded during a specific visit, are returned. Surgical procedures from finalized surgical cases will be returned as free text procedures, if the solution has been configured to write procedures from finalized cases to Procedure History.
+The Procedure resource returns medical and surgical procedures performed on or for a patient during their lifetime. Historical procedures and procedures recorded during a specific visit are returned. Surgical procedures from finalized surgical cases are returned as free-text procedures if the product is configured to write procedures from finalized cases to procedure history.
- - The following HL7® FHIR® US Core Implementation Guide STU 4.0.0 Profiles are supported by this resource:
+
- This resource supports the following HL7 FHIR US Core Implementation Guide STU 4.0.0 profiles:
@@ -115,19 +116,19 @@ Overview
The following fields are returned if valued:
Encounter
-Date performed
+Performed Period
- DateTime
- Period
@@ -137,14 +138,14 @@ Overview
Who recorded
Who performed
Location
@@ -152,7 +153,7 @@ Overview
Reason procedure performed
@@ -162,13 +163,19 @@ Overview
Annotation Author
+Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
+
+Errors
+
+The common errors and OperationOutcomes may be returned.
+
Terminology Bindings
@@ -359,7 +366,7 @@ Terminology Bindings
Search
-Search for Procedures that meet supplied query parameters:
+Search for procedures that meet supplied query parameters.
GET /Procedure?:parameters
@@ -384,39 +391,37 @@ Parameters
_idThis or patient or subject
-
+ Conditionally
tokenThe logical resource id associated with the resource.
+ The logical resource ID associated with the resource. This parameter is required if patient or subject is not used. Example: _id=7891
+
patientThis or _id or subject
-
+ Conditionally
referenceWho the procedure is for. Example: 12345
+ Who the procedure is for. This parameter is required if _id or subject is not used. Example: 12345
subjectThis or _id or patient
-
+ Conditionally
referenceWho the procedure is for. Example: Patient/12345
+ Who the procedure is for. This parameter is required if _id or patient is not used. Example: Patient/12345
dateNo
dateTimeDate range into which the procedure falls. Example: date=gt2015-09-24T12:00:00.000Z&date=le2020-07-15T16:00:00.000Z
+ The date range that the procedure’s performedPeriod or performedDateTime falls within. Example: date=gt2015-09-24T12:00:00.000Z&date=le2020-07-15T16:00:00.000Z
_revincludeNo
tokenProvenance resource entries to be returned as part of the bundle. Example:_revinclude=Provenance:target
+ The Provenance resource entries to be returned as part of the bundle. Example:_revinclude=Provenance:target
@@ -424,13 +429,22 @@ Parameters
Notes:
- - If
_id is provided, patient or subject can no longer be provided.
- - A
date parameter may be provided once with a prefix and time component to imply a date range. Alternately it may be provided twice with le, lt, ge, or gt prefixes and time component to search for procedures within a 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
date parameter:
+
+ - May be provided once with a prefix and time component to imply a date range. Example:
date=gt2015-09-24T00:00:00.000Z
- - The
_revinclude parameter may be provided in combination with the _id/patient parameter. Example: _id=570007845&_revinclude=Provenance:target or patient=12345&_revinclude=Provenance:target.
- - When
_revinclude is provided in a request to a closed endpoint, the OAuth2 token must include the user/Provenance.read scope.
- - Currently the
patient/Provenance.read scope is not supported and hence _revinclude cannot be utilised for patient persona.
+ - May otherwise be provided twice with
le, lt, ge, or gt prefixes and a time component to search for procedures 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 in combination with the
_id or patient parameter. Example: _id=570007845&_revinclude=Provenance:target or patient=12345&_revinclude=Provenance:target.
+ - When provided in a request to a closed endpoint, the OAuth2 token must include the
user/Provenance.read scope.
+
+
+ - Currently, the
patient/Provenance.read scope is not supported; hence, _revinclude cannot be used for patient persona.
Headers
@@ -541,9 +555,7 @@ Response
]
}
-Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
-
-Example with RevInclude
+Example With RevInclude
Authorization Types
@@ -697,8 +709,6 @@ Response
]
}
-Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
-
Patient Authorization Request
GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Procedure?patient=12724066
@@ -827,15 +837,10 @@ Response
}
]
}
-Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
-Errors
+Retrieve by ID
-The common errors and OperationOutcomes may be returned.
-
-Retrieve by id
-
-List an individual Procedure by its id:
+List an individual procedure by its ID.
GET /Procedure/:id
@@ -899,8 +904,6 @@ Response
}
}
-Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
-
Patient Authorization Request
GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Procedure/2572581295
@@ -967,7 +970,6 @@ Response
}
]
}
-Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Patient Authorization Request For Entered in Error Status
@@ -1005,24 +1007,18 @@ Response
"display": "MARSTON, JACK"
}
}
-Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
-
-Errors
-
-The common errors and OperationOutcomes may be returned.
Create
-Create a new Procedure.
+Create a new procedure.
POST /Procedure
-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.
Authorization Types
@@ -1695,12 +1691,6 @@ Response
The ETag response header indicates the current If-Match version to use on a subsequent update.
-Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
-
-Errors
-
-The common errors and OperationOutcomes may be returned.
-
diff --git a/millennium/r4/financial/general/insurance-plan/index.html b/millennium/r4/financial/general/insurance-plan/index.html
index b7228d257..fc1d8d861 100644
--- a/millennium/r4/financial/general/insurance-plan/index.html
+++ b/millennium/r4/financial/general/insurance-plan/index.html
@@ -68,7 +68,11 @@ Millennium
InsurancePlan
- - Overview
+ -
+Overview
+ - Errors
+
+
- Terminology Bindings
-
Search
@@ -76,27 +80,26 @@ InsurancePlan
- Parameters
- Headers
- Example
- - Errors
-
-Retrieve by id
Overview
-InsurancePlan describes a health insurance offering comprised of a list of covered benefits, costs associated with those benefits, and additional information about the offering, such as who it is owned and administered by, a coverage area contact information.
+The InsurancePlan resource is used to describe a health insurance offering and supports the return of a list of details, such as who it is owned and administered by, the plan’s coverage area, and contact information.
The following fields are returned if valued:
- - InsurancePlan id
+ - ID
+ - InsurancePlan identifier
- Status
- Type
- Name
@@ -104,6 +107,12 @@ Overview
- OwnedBy
+Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
+
+Errors
+
+The common errors and OperationOutcomes may be returned.
+
Terminology Bindings
@@ -168,7 +177,7 @@ Terminology Bindings
Search
-Search for InsurancePlans that meet supplied query parameters:
+Search for insurance plans that meet supplied query parameters:
GET /InsurancePlan?:parameters
@@ -185,7 +194,7 @@ Parameters
Name
- Required?
+ Required
Type
Description
@@ -193,20 +202,38 @@ Parameters
_idThis or owned-by
-
+ Conditionally
tokenThe logical resource id associated with the resource.
+ The logical resource ID associated with the resource. This parameter is required if the owned-by parameter is not used. Example: 1234
+
owned-byYes
+ Conditionally
referenceOrganization associated with the InsurancePlan.
+ The organization associated with the insurance plan. This parameter is required if the _id parameter is not used. Example: Organization/5678
+
+Implementation Notes
+
+
+ - The
_id and owned-by search parameters cannot be provided together.
+ - When searching with the
_id parameter:
+
+ - It can be provided with either a single value, or a comma-separated list of references. Example:
_id=12345 or _id=12345,67890
+
+
+
+ - When searching with the
owned-by parameter:
+
+ - It must be provided only once.
+
+
+
+
Headers
Accept: application/json+fhir
@@ -216,7 +243,7 @@ Example
Request
-GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/InsurancePlan?owned-by=589783
+GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/InsurancePlan?owned-by=Organization/589783
Response
@@ -242,7 +269,7 @@ Response
"id": "2798233",
"text": {
"status": "generated",
- "div": "<div xmlns='http://www.w3.org/1999/xhtml\\"><p><b>Insurance Plan</b></p><p><b>Name</b>:Medicare Part A</p><p><b>Type</b>: Medical Service Plan</p><p><b>Owned By</b>:Organization/589783</p><p><b>Period Start Date</b>: Aug 14, 2015 2:32 P.M. UTC</p></div>"
+ "div": "<div xmlns=\\"http://www.w3.org/1999/xhtml\\"><p><b>Insurance Plan</b></p><p><b>Name</b>:Medicare Part A</p><p><b>Type</b>: Medical Service Plan</p><p><b>Owned By</b>:Organization/589783</p><p><b>Period Start Date</b>: Aug 14, 2015 2:32 P.M. UTC</p></div>"
},
"status": "active",
"type": [
@@ -280,7 +307,7 @@ Response
"id": "3132244",
"text": {
"status": "generated",
- "div": "<div xmlns='http://www.w3.org/1999/xhtml\\"><p><b>Insurance Plan</b></p><p><b>Name</b>:Medicare Part A and B</p><p><b>Type</b>: Medical Service Plan</p><p><b>Owned By</b>:Organization/589783</p><p><b>Period Start Date</b>: Apr 3, 2018 8:37 P.M. UTC</p></div>"
+ "div": "<div xmlns=\\"http://www.w3.org/1999/xhtml\\"><p><b>Insurance Plan</b></p><p><b>Name</b>:Medicare Part A and B</p><p><b>Type</b>: Medical Service Plan</p><p><b>Owned By</b>:Organization/589783</p><p><b>Period Start Date</b>: Apr 3, 2018 8:37 P.M. UTC</p></div>"
},
"status": "active",
"type": [
@@ -318,7 +345,7 @@ Response
"id": "3132243",
"text": {
"status": "generated",
- "div": "<div xmlns='http://www.w3.org/1999/xhtml\\"><p><b>Insurance Plan</b></p><p><b>Name</b>:Medicare Part B</p><p><b>Type</b>: Medical Service Plan</p><p><b>Owned By</b>:Organization/589783</p><p><b>Period Start Date</b>: Apr 3, 2018 8:36 P.M. UTC</p></div>"
+ "div": "<div xmlns=\\"http://www.w3.org/1999/xhtml\\"><p><b>Insurance Plan</b></p><p><b>Name</b>:Medicare Part B</p><p><b>Type</b>: Medical Service Plan</p><p><b>Owned By</b>:Organization/589783</p><p><b>Period Start Date</b>: Apr 3, 2018 8:36 P.M. UTC</p></div>"
},
"status": "active",
"type": [
@@ -356,7 +383,7 @@ Response
"id": "3226346",
"text": {
"status": "generated",
- "div": "<div xmlns='http://www.w3.org/1999/xhtml\\"><p><b>Insurance Plan</b></p><p><b>Name</b>:Medicare Provider Liable</p><p><b>Type</b>: Medical Service Plan</p><p><b>Owned By</b>:Organization/589783</p><p><b>Period Start Date</b>: Apr 16, 2019 5:42 P.M. UTC</p></div>"
+ "div": "<div xmlns=\\"http://www.w3.org/1999/xhtml\\"><p><b>Insurance Plan</b></p><p><b>Name</b>:Medicare Provider Liable</p><p><b>Type</b>: Medical Service Plan</p><p><b>Owned By</b>:Organization/589783</p><p><b>Period Start Date</b>: Apr 16, 2019 5:42 P.M. UTC</p></div>"
},
"status": "active",
"type": [
@@ -390,15 +417,9 @@ Response
]
}
-Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
+Retrieve by ID
-Errors
-
-The common errors and OperationOutcomes may be returned.
-
-Retrieve by id
-
-List an individual InsurancePlan by its id:
+List an individual insurance plan by the associated ID:
GET /InsurancePlan/:id
@@ -462,12 +483,6 @@ Response
}
}
-Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
-
-Errors
-
-The common errors and OperationOutcomes may be returned.
-
diff --git a/millennium/r4/foundation/conformance/capability-statement/index.html b/millennium/r4/foundation/conformance/capability-statement/index.html
index c884f9d6a..034b0491f 100644
--- a/millennium/r4/foundation/conformance/capability-statement/index.html
+++ b/millennium/r4/foundation/conformance/capability-statement/index.html
@@ -120,20 +120,20 @@ Request
-
+
-
+
Status: 200 OK
{
@@ -142,10 +142,13 @@ Request
"name": "CernerCapabilityStatement",
"title": "Cerner Capability Statement",
"status": "active",
+ "date": "2023-11-21",
"publisher": "Cerner",
- "date": "2019-10-22",
"description": "Cerner implementation of FHIR on top of Millennium",
"kind": "instance",
+ "instantiates": [
+ "http://hl7.org/fhir/us/core/CapabilityStatement/us-core-server"
+ ],
"implementation": {
"description": "Cerner implementation of FHIR on top of Millennium",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d"
@@ -197,6 +200,11 @@ Request
"type": "reference",
"documentation": "The entity that caused the expenses. It is a required field if the _id or -guarantor fields are not given. Must be set with identifier."
},
+ {
+ "name": "-encounter",
+ "type": "reference",
+ "documentation": "The encounter associated with the resource."
+ },
{
"name": "-guarantor",
"type": "reference",
@@ -205,20 +213,20 @@ Request
{
"name": "type",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Account-type",
- "type": "string",
+ "type": "token",
"documentation": "The identifier for the account. Required in every search request."
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Account-identifier",
- "type": "number",
+ "type": "token",
"documentation": "Statement Account number. Must be set with patients"
},
{
"name": "_count",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
"type": "number",
- "documentation": "The maximum number of results to return. Not honoured when '_id' is set."
+ "documentation": "The maximum number of results to return in a page. Not honored when '_id' is set."
}
]
},
@@ -235,6 +243,9 @@ Request
"code": "search-type"
}
],
+ "searchRevInclude": [
+ "Provenance:target"
+ ],
"searchParam": [
{
"name": "_id",
@@ -244,13 +255,13 @@ Request
},
{
"name": "patient",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-patient",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient",
"type": "reference",
"documentation": "Who the sensitivity is for. It is a required field if the _id field is not given."
},
{
"name": "clinical-status",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/AllergyIntolerance-clinical-status",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-clinical-status",
"type": "token",
"documentation": "Certainty of the allergy or intolerance."
}
@@ -277,13 +288,18 @@ Request
"name": "_count",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
"type": "number",
- "documentation": "The maximum number of results to return. Not honoured when '_id' is set."
+ "documentation": "The maximum number of results to return in a page. Not honored when '_id' is set."
},
{
"name": "date",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Appointment-date",
"type": "date",
- "documentation": "A date or date range from which to find appointments. This must be set when using patient, practitioner or location. The 'date' parameter may be provided once without a prefix or time component to imply a date range or once without a prefix and with a time component to search for appointments at a specific time. Alternately it may be provided twice with 'le' and 'gt' prefixes to search for appointments within a specific range. The date prefix pair must create a closed range."
+ "documentation": "A date or date range from which to find appointments. This or the '-date-or-req-period' parameter must be set when using patient, practitioner or location. The 'date' parameter may be provided once without a prefix or time component to imply a date range or once without a prefix and with a time component to search for appointments at a specific time. Alternately it may be provided twice with 'le' and 'gt' prefixes to search for appointments within a specific range. The date prefix pair must create a closed range."
+ },
+ {
+ "name": "-date-or-req-period",
+ "type": "date",
+ "documentation": "A start date or requested period from which to find appointments. This or the 'date' parameter must be set when using patient, practitioner or location. The '-date-or-req-period' parameter may be provided once without a prefix or time component to imply a date range or once without a prefix and with a time component to search for appointments at a specific time. Alternately it may be provided twice with 'le' and 'gt' prefixes to search for appointments within a specific range. The date prefix pair must create a closed range."
},
{
"name": "patient",
@@ -311,6 +327,21 @@ Request
}
]
},
+ {
+ "type": "Binary",
+ "interaction": [
+ {
+ "code": "read"
+ }
+ ],
+ "operation": [
+ {
+ "name": "autogen-ccd-if",
+ "definition": "https://fhir-ehr.cerner.com/r4/OperationDefinition/binary-autogen-ccd-if",
+ "documentation": "Generate Continuity of Care Document (CCD)"
+ }
+ ]
+ },
{
"type": "CarePlan",
"supportedProfile": [
@@ -338,7 +369,7 @@ Request
"name": "date",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-date",
"type": "date",
- "documentation": "A date range with which to find CarePlans. If used, the ‘date’ parameter\n must be provided twice. Once with a 'ge' prefix representing the earliest date, and once\n with a 'le’ prefix representing the latest date. The date prefix pair must create a closed range."
+ "documentation": "A date range with which to find CarePlans. If used, the ‘date’ parameter must be provided twice. Once with a 'ge' prefix representing the earliest date, and once with a 'le’ prefix representing the latest date. The date prefix pair must create a closed range."
},
{
"name": "patient",
@@ -381,13 +412,13 @@ Request
"name": "_id",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
"type": "token",
- "documentation": "CareTeam id supports only the single id. It is a required field if the\n patient or encounter fields are not given."
+ "documentation": "CareTeam id supports only the single id. It is a required field if the patient or encounter fields are not given."
},
{
"name": "category",
"definition": "http://hl7.org/fhir/R4/SearchParameter/CareTeam-category",
"type": "token",
- "documentation": "The category of the careteam. Category Longitudinal (patient level) or Encounter\n is supported as of now."
+ "documentation": "The category of the careteam. Category Longitudinal (patient level) or Encounter is supported as of now."
},
{
"name": "encounter",
@@ -409,6 +440,100 @@ Request
}
]
},
+ {
+ "type": "ChargeItem",
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ }
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "ChargeItem id supports only the single id. It is a required field if the account or context fields are not given."
+ },
+ {
+ "name": "context",
+ "type": "reference",
+ "documentation": "Encounter associated with the ChargeItem. If provided, the '-status' parameter must also be provided. It is a required field if the _id or account fields are not given."
+ },
+ {
+ "name": "account",
+ "type": "reference",
+ "documentation": "Account associated with the ChargeItem. If provided, the '-status' parameter must also be provided. It is a required field if the _id or context fields are not given."
+ },
+ {
+ "name": "-status",
+ "type": "token",
+ "documentation": "The status of the ChargeItem. Must be set to 'billable'. Must be provided with the context and account parameter."
+ },
+ {
+ "name": "_count",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
+ "type": "number",
+ "documentation": "The maximum number of results to return in a page. Not honored when '_id' is set."
+ }
+ ],
+ "operation": [
+ {
+ "name": "credit",
+ "definition": "https://fhir-ehr.cerner.com/r4/OperationDefinition/charge-item-credit",
+ "documentation": "Creates an offsetting ChargeItem for an existing debit ChargeItem."
+ },
+ {
+ "name": "modify",
+ "definition": "https://fhir-ehr.cerner.com/r4/OperationDefinition/charge-item-modify",
+ "documentation": "Modifies an existing ChargeItem resulting in a newly created ChargeItem."
+ }
+ ]
+ },
+ {
+ "type": "Communication",
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ }
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of Communication ids. It is a required field if the category, -email-status, received and recipient fields are not given."
+ },
+ {
+ "name": "category",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Communication-category",
+ "type": "token",
+ "documentation": "The message category. It is a required field if the _id field is not given. Must be set with received, recipient and -email-status."
+ },
+ {
+ "name": "received",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Communication-received",
+ "type": "date",
+ "documentation": "When the message is received. It is a required field if the _id field is not given. Must be set with category, recipient and -email-status. If used, the ‘received’ parameter may be provided once or twice. Once with a 'ge' prefix representing the earliest received date, and/or once with a 'le’ prefix representing the latest received date."
+ },
+ {
+ "name": "recipient",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Communication-recipient",
+ "type": "reference",
+ "documentation": "The recipient of the message. It is a required field if the _id field is not given. Must be set with category, recipient and -email-status."
+ },
+ {
+ "name": "-email-status",
+ "type": "token",
+ "documentation": "The email status of the message. It is a required field if the _id field is not given. Must be set with category, received and recipient."
+ }
+ ]
+ },
{
"type": "Condition",
"supportedProfile": [
@@ -422,6 +547,9 @@ Request
"code": "search-type"
}
],
+ "searchRevInclude": [
+ "Provenance:target"
+ ],
"searchParam": [
{
"name": "_id",
@@ -431,10 +559,16 @@ Request
},
{
"name": "patient",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-patient",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-patient",
"type": "reference",
"documentation": "Who has the condition. It is a required field if the subject or _id fields are not given."
},
+ {
+ "name": "encounter",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Condition-encounter",
+ "type": "reference",
+ "documentation": "The encounter of the patient. Only encounter-diagnosis are returned."
+ },
{
"name": "subject",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Condition-subject",
@@ -443,23 +577,73 @@ Request
},
{
"name": "clinical-status",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/Condition-clinical-status",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-clinical-status",
"type": "token",
"documentation": "The clinical status of the condition."
},
{
"name": "category",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/Condition-category",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-category",
"type": "token",
"documentation": "The category of the condition. Categories problem-list-item, encounter-diagnosis and health-concern are supported as of now."
}
]
},
+ {
+ "type": "Consent",
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ }
+ ],
+ "searchInclude": [
+ "Consent:actor",
+ "Consent:patient"
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of Consent ids."
+ },
+ {
+ "name": "patient",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-patient",
+ "type": "reference",
+ "documentation": "Who the consent applies to. It is a required field if the _id field is not given."
+ },
+ {
+ "name": "actor",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Consent-actor",
+ "type": "reference",
+ "documentation": "Resource for the actor (or group, by role). It is a required field if the _id field is not given."
+ },
+ {
+ "name": "patient.identifier",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Consent-patient.identifier",
+ "type": "token",
+ "documentation": "The patient.identifier allows to search by patient aliases. Federated Person Principle, SSN, MRN etc... are supported as of now. It is a required field if the _id field is not given."
+ },
+ {
+ "name": "actor.identifier",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Consent-actor.identifier",
+ "type": "token",
+ "documentation": "The actor.identifier allows to search by related person aliases. Federated Person Principle is the only supported alias as of now. It is a required field if the _id field is not given."
+ }
+ ]
+ },
{
"type": "Coverage",
"interaction": [
{
"code": "search-type"
+ },
+ {
+ "code": "delete"
}
],
"searchParam": [
@@ -468,6 +652,11 @@ Request
"definition": "http://hl7.org/fhir/R4/SearchParameter/Coverage-patient",
"type": "reference",
"documentation": "Retrieve coverages for a patient."
+ },
+ {
+ "name": "-encounter",
+ "type": "reference",
+ "documentation": "Retrieve coverages for an encounter."
}
]
},
@@ -484,6 +673,9 @@ Request
"code": "search-type"
}
],
+ "searchRevInclude": [
+ "Provenance:target"
+ ],
"searchParam": [
{
"name": "_id",
@@ -493,16 +685,17 @@ Request
},
{
"name": "patient",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/Device-patient",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-device-patient",
"type": "reference",
"documentation": "The patient to whom Device is affixed. It is a required field if the _id field is not given."
}
]
},
{
- "type": "DocumentReference",
+ "type": "DiagnosticReport",
"supportedProfile": [
- "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note",
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab"
],
"interaction": [
{
@@ -510,15 +703,69 @@ Request
},
{
"code": "search-type"
+ }
+ ],
+ "searchRevInclude": [
+ "Provenance:target"
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of DiagnosticReport ids. It is a required field if the patient field is not given."
},
{
- "code": "create"
+ "name": "category",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-category",
+ "type": "token",
+ "documentation": "Which diagnostic discipline/department created the report."
},
{
- "code": "update"
+ "name": "code",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-code",
+ "type": "token",
+ "documentation": "The code for the report."
+ },
+ {
+ "name": "encounter",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-encounter",
+ "type": "reference",
+ "documentation": "The Encounter when the report was made."
+ },
+ {
+ "name": "patient",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-patient",
+ "type": "reference",
+ "documentation": "The subject of the report. It is a required field."
+ },
+ {
+ "name": "date",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-date",
+ "type": "date",
+ "documentation": "A date range with which to find Documents. A date parameter may be provided once with or without prefix and time component to imply a date range. Alternately it may be provided twice with 'le', 'lt', 'ge', or 'gt' prefixes and time component to search for procedures within a specific range. The date and prefix pairs must create a closed range. Must be set with patient or subject."
+ },
+ {
+ "name": "_count",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
+ "type": "number",
+ "documentation": "The maximum number of results to return in a page."
+ }
+ ]
+ },
+ {
+ "type": "DocumentReference",
+ "supportedProfile": [
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
+ ],
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
}
],
- "updateCreate": false,
"searchRevInclude": [
"Provenance:target"
],
@@ -527,13 +774,13 @@ Request
"name": "_id",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-id",
"type": "token",
- "documentation": "A single or comma separated list of DocumentReference ids.\n It is a required field if the patient field is not given."
+ "documentation": "A single or comma separated list of DocumentReference ids. It is a required field if the patient field is not given."
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-patient",
"type": "reference",
- "documentation": "The patient the document is about.\n It is a required field if the subject field is not given."
+ "documentation": "The patient the document is about. It is a required field if the subject field is not given."
},
{
"name": "encounter",
@@ -545,7 +792,7 @@ Request
"name": "period",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-period",
"type": "date",
- "documentation": "A date range with which to find Documents. If used, the 'period' parameter\n must be provided twice. Once with a 'ge' prefix representing the earliest date, and once with\n a 'lt' prefix representing the latest date. The period prefix pair must create a closed range\n and cannot be equal to each other."
+ "documentation": "A date range with which to find Documents. If used, the 'period' parameter must be provided twice. Once with a 'ge' prefix representing the earliest date, and once with a 'lt' prefix representing the latest date. The period prefix pair must create a closed range and cannot be equal to each other."
},
{
"name": "_count",
@@ -569,7 +816,7 @@ Request
"name": "date",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-date",
"type": "date",
- "documentation": "A date parameter may be provided once with a prefix and time component to\n imply a date range. Alternately it may be provided twice with 'le', 'lt', 'ge', or 'gt'\n prefixes and time component to search for procedures within a specific range. The date and\n prefix pairs must create a closed range. Must be set with patient."
+ "documentation": "It must be provided once with a prefix to imply a date range or without a prefix to search for document(s) at a specific date. Alternately it may be provided twice with `le`, `lt`, `ge`, or `gt` prefixes to search for document(s) within specific range. The date and prefix pairs must create a closed range. For a single 'date' occurrence, `time` component is optional but for two `date` occurrences, must include `time` component."
}
],
"operation": [
@@ -593,30 +840,82 @@ Request
"code": "search-type"
}
],
+ "searchRevInclude": [
+ "Provenance:target"
+ ],
"searchParam": [
{
"name": "_id",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-id",
"type": "token",
- "documentation": "A single or comma separated list of Encounter ids. It is a required field if the patient or subject fields are not given."
+ "documentation": "A single or comma separated list of Encounter ids. It is a required field if the account or identifier or -pageContext or patient or subject fields are not given."
},
{
"name": "_count",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
"type": "number",
- "documentation": "The maximum number of results to return. Not honored when '_id' is set."
+ "documentation": "The maximum number of results to return in a page. Not honored when '_id' is set."
},
{
"name": "patient",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-patient",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-patient",
"type": "reference",
- "documentation": "The patient present at the encounter. It is a required field if the _id or subject fields are not given."
+ "documentation": "The patient present at the encounter. It is a required field if the account or _id or identifier or -pageContext or subject fields are not given."
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Encounter-subject",
"type": "reference",
- "documentation": "The patient present at the encounter. It is a required field if the _id or patient fields are not given."
+ "documentation": "The patient present at the encounter. It is a required field if the account or _id or identifier or -pageContext or patient fields are not given."
+ },
+ {
+ "name": "status",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-status",
+ "type": "token",
+ "documentation": "The status of the encounter. Must be set with patient."
+ },
+ {
+ "name": "date",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-date",
+ "type": "date",
+ "documentation": "A date parameter may be provided once with a prefix and time component to imply a date range. Alternately it may be provided twice with 'le', 'lt', 'ge', or 'gt' prefixes and time component to search for encounters within a specific range. The date and prefix pairs must create a closed range. Must be set with patient or subject."
+ },
+ {
+ "name": "identifier",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-identifier",
+ "type": "token",
+ "documentation": "An encounter's identifier. It is a required field if the account or _id or -pageContext or patient or subject fields are not given."
+ }
+ ]
+ },
+ {
+ "type": "FamilyMemberHistory",
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ }
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of FamilyMemberHistory ids. It is a required field if the patient field is not given."
+ },
+ {
+ "name": "patient",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-patient",
+ "type": "reference",
+ "documentation": "Who the family member history is for. It is a required field if the _id field is not given. It is a required field if the status parameter is provided."
+ },
+ {
+ "name": "status",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/status",
+ "type": "token",
+ "documentation": "The status of the FamilyMemberHistory."
}
]
},
@@ -641,7 +940,7 @@ Request
"name": "_id",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
"type": "token",
- "documentation": "Goal id supports only the single id. It is a required field if\n the patient field is not given."
+ "documentation": "Goal id supports only the single id. It is a required field if the patient field is not given."
},
{
"name": "patient",
@@ -670,6 +969,9 @@ Request
"code": "search-type"
}
],
+ "searchRevInclude": [
+ "Provenance:target"
+ ],
"searchParam": [
{
"name": "_id",
@@ -679,23 +981,26 @@ Request
},
{
"name": "patient",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-patient",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-patient",
"type": "reference",
"documentation": "The patient for the vaccination record. It is a required field if the _id field is not given."
},
{
"name": "date",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-date",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-date",
"type": "date",
"documentation": "Vaccination (non)-Administration Date."
+ },
+ {
+ "name": "target-disease",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-target-disease",
+ "type": "token",
+ "documentation": "A single or comma separated list of target diseases the dose is being administered against."
}
]
},
{
- "type": "Location",
- "supportedProfile": [
- "http://hl7.org/fhir/us/core/StructureDefinition/us-core-location"
- ],
+ "type": "InsurancePlan",
"interaction": [
{
"code": "read"
@@ -709,18 +1014,46 @@ Request
"name": "_id",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
"type": "token",
- "documentation": "A single or comma separated list of Location ids. It is a\n required field if the -physicalType field is not given"
- },
- {
- "name": "-physicalType",
- "type": "token",
- "documentation": "The Location's physical type. It is a required field if the _id field is not given"
+ "documentation": "A single or comma separated list of InsurancePlan ids."
},
{
- "name": "identifier",
- "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-location-identifier",
- "type": "token",
- "documentation": "A location's identifier."
+ "name": "owned-by",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/InsurancePlan-owned-by",
+ "type": "reference",
+ "documentation": "The organization that is providing the health insurance product."
+ }
+ ]
+ },
+ {
+ "type": "Location",
+ "supportedProfile": [
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-location"
+ ],
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ }
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of Location ids. It is a required field if the -physicalType field is not given"
+ },
+ {
+ "name": "-physicalType",
+ "type": "token",
+ "documentation": "The Location's physical type. It is a required field if the _id field is not given"
+ },
+ {
+ "name": "identifier",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-location-identifier",
+ "type": "token",
+ "documentation": "A location's identifier."
},
{
"name": "address",
@@ -730,7 +1063,7 @@ Request
{
"name": "address-city",
"type": "string",
- "documentation": "A city specified in an address. It is a required field if the\n address-state or address-postalcode fields are not given"
+ "documentation": "A city specified in an address. It is a required field if the address-state or address-postalcode fields are not given"
},
{
"name": "address-state",
@@ -754,6 +1087,234 @@ Request
}
]
},
+ {
+ "type": "MedicationAdministration",
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ }
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of MedicationAdministration ids."
+ },
+ {
+ "name": "patient",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/medicationadministration-patient",
+ "type": "reference",
+ "documentation": "The identity of a patient to list administrations for. It is a required field if the _id field is not given."
+ },
+ {
+ "name": "status",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/medicationadministration-status",
+ "type": "token",
+ "documentation": "MedicationAdministration event status."
+ },
+ {
+ "name": "performer",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/medicationadministration-performer",
+ "type": "reference",
+ "documentation": "The identity of the individual who administered the medication."
+ },
+ {
+ "name": "effective-time",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/medicationadministration-effective-time",
+ "type": "date",
+ "documentation": "A effective-time parameter may be provided once with 'le' or 'lt' or 'ge' or 'gt' prefix and time component to imply a date range. Alternately it may be provided twice with 'le', 'lt', 'ge', or 'gt' prefixes and time component to search for medications administered within a specific range. The date and prefix pairs must create a closed range."
+ }
+ ]
+ },
+ {
+ "type": "MedicationRequest",
+ "supportedProfile": [
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"
+ ],
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ }
+ ],
+ "searchRevInclude": [
+ "Provenance:target"
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of MedicationRequest ids."
+ },
+ {
+ "name": "patient",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-patient",
+ "type": "reference",
+ "documentation": "The patient to return MedicationRequests for. It is a required field if the _id field is not given."
+ },
+ {
+ "name": "intent",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-intent",
+ "type": "token",
+ "documentation": "The intent of the MedicationRequest."
+ },
+ {
+ "name": "status",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-status",
+ "type": "token",
+ "documentation": "The status of the MedicationRequest."
+ },
+ {
+ "name": "_lastUpdated",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-lastUpdated",
+ "type": "date",
+ "documentation": "When the resource version last changed."
+ },
+ {
+ "name": "-timing-boundsPeriod",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-dosageInstruction-timing-repeat-boundsPeriod",
+ "type": "date",
+ "documentation": "The date-time within the period the medication should be given to the patient. Must be prefixed by 'ge'."
+ },
+ {
+ "name": "_count",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
+ "type": "number",
+ "documentation": "The maximum number of results to return in a page. Not honored when '_id' is set."
+ }
+ ]
+ },
+ {
+ "type": "NutritionOrder",
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ }
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of NutritionOrder ids."
+ },
+ {
+ "name": "patient",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-patient",
+ "type": "reference",
+ "documentation": "The patient to return NutritionOrders for. It is a required field if the _id field is not given."
+ },
+ {
+ "name": "status",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/NutritionOrder-status",
+ "type": "token",
+ "documentation": "The status of the NutritionOrder."
+ },
+ {
+ "name": "_lastUpdated",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-lastUpdated",
+ "type": "date",
+ "documentation": "When the resource version last changed."
+ },
+ {
+ "name": "_count",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
+ "type": "number",
+ "documentation": "The maximum number of results to return in a page. Not honored when '_id' is set."
+ }
+ ]
+ },
+ {
+ "type": "Observation",
+ "supportedProfile": [
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab",
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-bmi",
+ "http://hl7.org/fhir/us/core/StructureDefinition/pediatric-weight-for-height",
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry",
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus",
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-blood-pressure",
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-height",
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-weight",
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-heart-rate",
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-respiratory-rate",
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-temperature",
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-head-circumference",
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs",
+ "http://hl7.org/fhir/us/core/StructureDefinition/pediatric-bmi-for-age",
+ "http://hl7.org/fhir/us/core/StructureDefinition/head-occipital-frontal-circumference-percentile"
+ ],
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ }
+ ],
+ "searchRevInclude": [
+ "Provenance:target"
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of Observation ids. It is a required field if the patient field is not given."
+ },
+ {
+ "name": "patient",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-patient",
+ "type": "reference",
+ "documentation": "The patient the observation is about. It is a required field if the subject field is not given."
+ },
+ {
+ "name": "subject",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Observation-subject",
+ "type": "reference",
+ "documentation": "The patient subject the observation is about. It is a required field if the patient field is not given."
+ },
+ {
+ "name": "category",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-category",
+ "type": "token",
+ "documentation": "A single or comma separated list of classifications of the type of observation."
+ },
+ {
+ "name": "code",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-code",
+ "type": "token",
+ "documentation": "A single or comma separated list of observation types."
+ },
+ {
+ "name": "date",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-date",
+ "type": "date",
+ "documentation": "A date or date range from which to find observations. The 'date' parameter may be provided once without a prefix or time component to imply a date range or once without a prefix and with a time component to search for observations at a specific time. Alternately it may be provided twice with 'le', 'lt', 'ge', or 'gt' prefixes to search for observations within a specific range. The date and prefix pairs must create a closed range."
+ },
+ {
+ "name": "_lastUpdated",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-lastUpdated",
+ "type": "date",
+ "documentation": "A date or date range used to search for observations which were last updated in that period. The '_lastUpdated' parameter may be provided once without a prefix or time component to imply a date range or once without a prefix and with a time component to search for observations at a specific time. Alternately it may be provided twice with 'le', 'lt', 'ge', or 'gt' prefixes to search for observations within a specific range. The date and prefix pairs must create a closed range."
+ },
+ {
+ "name": "_count",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
+ "type": "number",
+ "documentation": "The maximum number of results to return in a page."
+ }
+ ]
+ },
{
"type": "OperationDefinition",
"interaction": [
@@ -762,6 +1323,65 @@ Request
}
]
},
+ {
+ "type": "Organization",
+ "supportedProfile": [
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
+ ],
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ }
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of Organization ids."
+ },
+ {
+ "name": "identifier",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Organization-identifier",
+ "type": "token",
+ "documentation": "The Organization's Identifier."
+ },
+ {
+ "name": "type",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Organization-type",
+ "type": "token",
+ "documentation": "The Organization's type."
+ },
+ {
+ "name": "_count",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Organization-count",
+ "type": "number",
+ "documentation": "The maximum number of results to return in a page."
+ },
+ {
+ "name": "name",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Organization-name",
+ "type": "string",
+ "documentation": "The Organization's name."
+ },
+ {
+ "name": "address",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Organization-address",
+ "type": "string",
+ "documentation": "The Organization's address."
+ }
+ ],
+ "operation": [
+ {
+ "name": "get-cg-for-mrcu",
+ "definition": "https://fhir-ehr.cerner.com/r4/OperationDefinition/organization-get-cg-for-mrcu",
+ "documentation": "Retrieves details for a caregiver organization given a care unit organization id."
+ }
+ ]
+ },
{
"type": "Patient",
"supportedProfile": [
@@ -775,34 +1395,37 @@ Request
"code": "search-type"
}
],
+ "searchRevInclude": [
+ "Provenance:target"
+ ],
"searchParam": [
{
"name": "_id",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-id",
"type": "token",
"documentation": "A single or comma separated list of Patient ids. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided."
},
{
"name": "identifier",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/Patient-identifier",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-identifier",
"type": "token",
"documentation": "A patient identifier. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided."
},
{
"name": "name",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/Patient-name",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-name",
"type": "string",
"documentation": "The beginning of any name of the patient. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided."
},
{
"name": "given",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/individual-given",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-given",
"type": "string",
"documentation": "The beginning of the given name of the patient. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided."
},
{
"name": "family",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/individual-family",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-family",
"type": "string",
"documentation": "The beginning of the family name of the patient. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided."
},
@@ -814,7 +1437,7 @@ Request
},
{
"name": "birthdate",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/individual-birthdate",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-birthdate",
"type": "date",
"documentation": "The date of birth of the patient. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided."
},
@@ -832,7 +1455,7 @@ Request
},
{
"name": "gender",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/individual-gender",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-gender",
"type": "token",
"documentation": "The administrative gender of the patient. Gender may only be provided if another parameter other than '_id' is provided"
},
@@ -840,22 +1463,19 @@ Request
"name": "_count",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
"type": "number",
- "documentation": "The maximum number of results to return. Not honoured when '_id' or 'identifier' are set."
+ "documentation": "The maximum number of results to return in a page. Not honored when '_id' or 'identifier' are set."
}
],
"operation": [
{
"name": "health-cards-issue",
"definition": "https://spec.smarthealth.cards/artifacts/operation-patient-i-health-cards-issue.json",
- "documentation": "Issues verifiable health cards for the patient"
+ "documentation": "Issues verifiable health cards for the patient."
}
]
},
{
- "type": "Practitioner",
- "supportedProfile": [
- "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"
- ],
+ "type": "Person",
"interaction": [
{
"code": "read"
@@ -869,12 +1489,21 @@ Request
"name": "_id",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
"type": "token",
- "documentation": "A single or comma separated list of Practitioner ids."
+ "documentation": "A single or comma separated list of Person ids. It is a required field if the identifier field is not given"
+ },
+ {
+ "name": "identifier",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Person-identifier",
+ "type": "token",
+ "documentation": "A person's Identifier. It is a required field if the _id field is not given"
}
]
},
{
- "type": "RelatedPerson",
+ "type": "Practitioner",
+ "supportedProfile": [
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"
+ ],
"interaction": [
{
"code": "read"
@@ -888,19 +1517,320 @@ Request
"name": "_id",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
"type": "token",
- "documentation": "A single or comma separated list of RelatedPerson ids. It is a required field if the identifier or patient fields are not given."
+ "documentation": "A single or comma separated list of Practitioner ids. Either the '_id', 'identifier', 'name', 'active' or 'family' parameter, or a combination of 'given' and 'family' parameters must be provided."
+ },
+ {
+ "name": "identifier",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-practitioner-identifier",
+ "type": "token",
+ "documentation": "A practitioner's Identifier. Either the '_id', 'identifier', 'name', 'active' or 'family' parameter, or a combination of 'given' and 'family' parameters must be provided."
+ },
+ {
+ "name": "given",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/individual-given",
+ "type": "string",
+ "documentation": "The beginning of the given name of the practitioner. Either the '_id', 'identifier', 'name', 'active' or 'family' parameter, or a combination of 'given' and 'family' parameters must be provided."
+ },
+ {
+ "name": "family",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/individual-family",
+ "type": "string",
+ "documentation": "The beginning of the family name of the practitioner. Either the '_id', 'identifier', 'name', 'active' or 'family' parameter, or a combination of 'given' and 'family' parameters must be provided."
+ },
+ {
+ "name": "name",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/individual-name",
+ "type": "string",
+ "documentation": "The beginning of the first, last or middle name of the practitioner. Either the '_id', 'identifier', 'name', 'active' or 'family' parameter, or a combination of 'given' and 'family' parameters must be provided."
+ },
+ {
+ "name": "active",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-active",
+ "type": "token",
+ "documentation": "Whether the practitioner record is active. Either the '_id', 'identifier', 'name', 'active' or 'family' parameter, or a combination of 'given' and 'family' parameters must be provided."
+ },
+ {
+ "name": "_count",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
+ "type": "number",
+ "documentation": "The maximum number of results to return in a page. Not honored when '_id' is set. Either the '_id', 'identifier', 'name', 'active' or 'family' parameter, or a combination of 'given' and 'family' parameters must be provided."
+ }
+ ]
+ },
+ {
+ "type": "Procedure",
+ "supportedProfile": [
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
+ ],
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ }
+ ],
+ "searchRevInclude": [
+ "Provenance:target"
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of Procedure ids. It is a required field if the patient or subject fields are not given"
+ },
+ {
+ "name": "patient",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-patient",
+ "type": "reference",
+ "documentation": "Search by subject - a patient. It is a required field if the _id or subject fields are not given"
+ },
+ {
+ "name": "subject",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-patient",
+ "type": "reference",
+ "documentation": "Search by subject. It is a required field if the _id or patient fields are not given"
+ },
+ {
+ "name": "date",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-date",
+ "type": "date",
+ "documentation": "A date parameter may be provided once without a prefix or time component to imply a date range or once without a prefix and with a time component. Alternately it may be provided twice with 'le', 'lt', 'ge', or 'gt' prefixes to search for procedures within a specific range. The date and prefix pairs must create a closed range. Must be set with patient or subject."
+ }
+ ]
+ },
+ {
+ "type": "Provenance",
+ "supportedProfile": [
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance"
+ ],
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ }
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of Provenance ids. It is a required field if the target field is not given"
+ },
+ {
+ "name": "target",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Provenance-target",
+ "type": "reference",
+ "documentation": "The resource(s) the Provenance is associated with. It is a required field if the _id field is not given"
+ }
+ ]
+ },
+ {
+ "type": "Questionnaire",
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ }
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of Questionnaire ids."
+ }
+ ]
+ },
+ {
+ "type": "QuestionnaireResponse",
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ }
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of QuestionnaireResponse ids. It is a required field if the patient field is not given."
+ },
+ {
+ "name": "patient",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/QuestionnaireResponse-patient",
+ "type": "reference",
+ "documentation": "The patient that is the subject of the questionnaire response. It is a required field if the _id field is not given"
+ }
+ ]
+ },
+ {
+ "type": "RelatedPerson",
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ }
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of RelatedPerson ids. It is a required field if the identifier or patient or -encounter fields are not given."
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Patient-identifier",
"type": "token",
- "documentation": "An Identifier of the RelatedPerson. It is a required field if the id or patient fields are not given"
+ "documentation": "An Identifier of the RelatedPerson. It is a required field if the id or patient or -encounter fields are not given"
+ },
+ {
+ "name": "patient",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-patient",
+ "type": "reference",
+ "documentation": "The patient this related person is related to. It is a required field if the id or identifier or -encounter fields are not given"
+ },
+ {
+ "name": "-encounter",
+ "type": "reference",
+ "documentation": "The encounter this related person is related to. It is a required field if the id or identifier or patient fields are not given"
+ },
+ {
+ "name": "-relationship-level",
+ "type": "token",
+ "documentation": "The resource's relationship to either the patient or encounter level. Must be provided with Patient and Identifier searches."
+ }
+ ]
+ },
+ {
+ "type": "Schedule",
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ }
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of Schedule ids. The '_id' parameter must be set."
+ }
+ ]
+ },
+ {
+ "type": "ServiceRequest",
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ }
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of ServiceRequest ids."
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-patient",
"type": "reference",
- "documentation": "The patient this related person is related to. It is a required field if the id or identifier fields are not given"
+ "documentation": "The patient to return ServiceRequests for. It is a required field if the subject or _id fields are not given."
+ },
+ {
+ "name": "subject",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/ServiceRequest-subject",
+ "type": "reference",
+ "documentation": "Individual or Entity the service is ordered for. It is a required field if the patient or _id fields are not given."
+ },
+ {
+ "name": "code",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-code",
+ "type": "token",
+ "documentation": "What is being requested/ordered."
+ },
+ {
+ "name": "_lastUpdated",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-lastUpdated",
+ "type": "date",
+ "documentation": "When the resource version last changed."
+ },
+ {
+ "name": "_count",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
+ "type": "number",
+ "documentation": "The maximum number of results to return in a page. Not honored when '_id' is set."
+ }
+ ]
+ },
+ {
+ "type": "Slot",
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ }
+ ],
+ "searchInclude": [
+ "Slot:schedule",
+ "Schedule:actor:Practitioner"
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of Slot ids. Either the '_id' parameter or 'service-type' must be set."
+ },
+ {
+ "name": "start",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Slot-date",
+ "type": "date",
+ "documentation": "A date or date range from which the slots are to be retrieved. The 'start' parameter is required when service-type, schedule.actor, -location is provided. When provided, must use both 'lt' and 'ge' prefixes to search for slots within a specific range. Time component should be provided for both the instances. The date and prefix pairs must create a closed range."
+ },
+ {
+ "name": "service-type",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Service-type",
+ "type": "token",
+ "documentation": "A single or comma separated list of appointment types that can be booked into the slot. Either the '_id' parameter or 'service-type' must be set."
+ },
+ {
+ "name": "schedule.actor",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Slot-schedule.actor",
+ "type": "reference",
+ "documentation": "A single or comma separated list of schedule actors. Must be Practitioner actors."
+ },
+ {
+ "name": "-location",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Slot-location",
+ "type": "reference",
+ "documentation": "A single or comma separated list of Location references."
+ },
+ {
+ "name": "_count",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
+ "type": "number",
+ "documentation": "The maximum number of results to return in a page. This value should be in the range [5,200]. If no value is provided, a default page size of 50 will be used."
}
]
},
@@ -932,35 +1862,39 @@ Request
-
+
-
+
Status: 200 OK
{
"resourceType": "CapabilityStatement",
- "url": "https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/metadata",
+ "url": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/metadata",
"name": "CernerCapabilityStatement",
"title": "Cerner Capability Statement",
"status": "active",
+ "date": "2023-11-21",
"publisher": "Cerner",
- "date": "2019-10-22",
"description": "Cerner implementation of FHIR on top of Millennium",
"kind": "instance",
+ "instantiates": [
+ "http://hl7.org/fhir/us/core/CapabilityStatement/us-core-server",
+ "http://hl7.org/fhir/uv/bulkdata/CapabilityStatement/bulk-data"
+ ],
"implementation": {
"description": "Cerner implementation of FHIR on top of Millennium",
- "url": "https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d"
+ "url": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d"
},
"fhirVersion": "4.0.1",
"format": [
@@ -977,17 +1911,29 @@ Request
"security": {
"extension": [
{
- "url": "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris",
"extension": [
{
- "url": "token",
- "valueUri": "https://authorization.cerner.com/tenants/ec2458f2-1e24-41c8-b71b-0e701af7583d/protocols/oauth2/profiles/smart-v1/token"
+ "valueUri": "https://authorization.cerner.com/tenants/ec2458f2-1e24-41c8-b71b-0e701af7583d/protocols/oauth2/profiles/smart-v1/token",
+ "url": "token"
+ },
+ {
+ "valueUri": "https://authorization.cerner.com/tenants/ec2458f2-1e24-41c8-b71b-0e701af7583d/protocols/oauth2/profiles/smart-v1/token/revoke",
+ "url": "revoke"
+ },
+ {
+ "valueUri": "https://authorization.cerner.com/tenants/ec2458f2-1e24-41c8-b71b-0e701af7583d/protocols/oauth2/profiles/smart-v1/personas/provider/authorize",
+ "url": "authorize"
+ },
+ {
+ "valueUri": "https://authorization.cerner.com/tenants/ec2458f2-1e24-41c8-b71b-0e701af7583d/personas/provider/my-authorizations",
+ "url": "manage"
},
{
- "url": "authorize",
- "valueUri": "https://authorization.cerner.com/tenants/ec2458f2-1e24-41c8-b71b-0e701af7583d/protocols/oauth2/profiles/smart-v1/personas/provider/authorize"
+ "valueUri": "https://authorization.cerner.com/tokeninfo",
+ "url": "introspect"
}
- ]
+ ],
+ "url": "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris"
}
],
"cors": true,
@@ -1036,6 +1982,11 @@ Request
"type": "reference",
"documentation": "The entity that caused the expenses. It is a required field if the _id or -guarantor fields are not given. Must be set with identifier."
},
+ {
+ "name": "-encounter",
+ "type": "reference",
+ "documentation": "The encounter associated with the resource."
+ },
{
"name": "-guarantor",
"type": "reference",
@@ -1044,20 +1995,20 @@ Request
{
"name": "type",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Account-type",
- "type": "string",
+ "type": "token",
"documentation": "The identifier for the account. Required in every search request."
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Account-identifier",
- "type": "number",
+ "type": "token",
"documentation": "Statement Account number. Must be set with patients"
},
{
"name": "_count",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
"type": "number",
- "documentation": "The maximum number of results to return. Not honoured when '_id' is set."
+ "documentation": "The maximum number of results to return in a page. Not honored when '_id' is set."
}
]
},
@@ -1072,9 +2023,19 @@ Request
},
{
"code": "search-type"
+ },
+ {
+ "code": "create"
+ },
+ {
+ "code": "update"
}
],
- "searchParam": [
+ "updateCreate": false,
+ "searchRevInclude": [
+ "Provenance:target"
+ ],
+ "searchParam": [
{
"name": "_id",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
@@ -1083,32 +2044,921 @@ Request
},
{
"name": "patient",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-patient",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient",
"type": "reference",
"documentation": "Who the sensitivity is for. It is a required field if the _id field is not given."
},
{
"name": "clinical-status",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/AllergyIntolerance-clinical-status",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-clinical-status",
"type": "token",
"documentation": "Certainty of the allergy or intolerance."
}
]
},
{
- "type": "Appointment",
+ "type": "Appointment",
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ },
+ {
+ "code": "create"
+ },
+ {
+ "code": "patch"
+ }
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of Appointment ids. Either the '_id' parameter or one of the 'patient', 'practitioner' or 'location' parameters must be set."
+ },
+ {
+ "name": "_count",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
+ "type": "number",
+ "documentation": "The maximum number of results to return in a page. Not honored when '_id' is set."
+ },
+ {
+ "name": "date",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Appointment-date",
+ "type": "date",
+ "documentation": "A date or date range from which to find appointments. This or the '-date-or-req-period' parameter must be set when using patient, practitioner or location. The 'date' parameter may be provided once without a prefix or time component to imply a date range or once without a prefix and with a time component to search for appointments at a specific time. Alternately it may be provided twice with 'le' and 'gt' prefixes to search for appointments within a specific range. The date prefix pair must create a closed range."
+ },
+ {
+ "name": "-date-or-req-period",
+ "type": "date",
+ "documentation": "A start date or requested period from which to find appointments. This or the 'date' parameter must be set when using patient, practitioner or location. The '-date-or-req-period' parameter may be provided once without a prefix or time component to imply a date range or once without a prefix and with a time component to search for appointments at a specific time. Alternately it may be provided twice with 'le' and 'gt' prefixes to search for appointments within a specific range. The date prefix pair must create a closed range."
+ },
+ {
+ "name": "patient",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Appointment-patient",
+ "type": "reference",
+ "documentation": "One of the individuals of the appointment is this patient. Either the '_id' parameter or one of the 'patient', 'practitioner' or 'location' parameters must be set."
+ },
+ {
+ "name": "practitioner",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Appointment-practitioner",
+ "type": "reference",
+ "documentation": "One of the individuals of the appointment is this practitioner. Either the '_id' parameter or one of the 'patient', 'practitioner' or 'location' parameters must be set."
+ },
+ {
+ "name": "location",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Appointment-location",
+ "type": "reference",
+ "documentation": "This location is listed in the participants of the appointment. Either the '_id' parameter or one of the 'patient', 'practitioner' or 'location' parameters must be set."
+ },
+ {
+ "name": "status",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Appointment-status",
+ "type": "token",
+ "documentation": "The overall status of the appointment."
+ }
+ ]
+ },
+ {
+ "type": "Basic",
+ "interaction": [
+ {
+ "code": "create"
+ }
+ ]
+ },
+ {
+ "type": "Binary",
+ "interaction": [
+ {
+ "code": "read"
+ }
+ ],
+ "operation": [
+ {
+ "name": "autogen-ccd-if",
+ "definition": "https://fhir-ehr.cerner.com/r4/OperationDefinition/binary-autogen-ccd-if",
+ "documentation": "Generate Continuity of Care Document (CCD)"
+ }
+ ]
+ },
+ {
+ "type": "CarePlan",
+ "supportedProfile": [
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
+ ],
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ }
+ ],
+ "searchRevInclude": [
+ "Provenance:target"
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of CarePlan ids."
+ },
+ {
+ "name": "date",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-date",
+ "type": "date",
+ "documentation": "A date range with which to find CarePlans. If used, the ‘date’ parameter must be provided twice. Once with a 'ge' prefix representing the earliest date, and once with a 'le’ prefix representing the latest date. The date prefix pair must create a closed range."
+ },
+ {
+ "name": "patient",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-patient",
+ "type": "reference",
+ "documentation": "Who the careplan is for. It is a required field if the _id field is not given."
+ },
+ {
+ "name": "category",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-category",
+ "type": "token",
+ "documentation": "The category of the careplan. Category assess-plan is supported as of now."
+ },
+ {
+ "name": "_count",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
+ "type": "number",
+ "documentation": "The maximum number of results to return. Not honored when '_id' is set."
+ }
+ ]
+ },
+ {
+ "type": "CareTeam",
+ "supportedProfile": [
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam"
+ ],
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ }
+ ],
+ "searchRevInclude": [
+ "Provenance:target"
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "CareTeam id supports only the single id. It is a required field if the patient or encounter fields are not given."
+ },
+ {
+ "name": "category",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/CareTeam-category",
+ "type": "token",
+ "documentation": "The category of the careteam. Category Longitudinal (patient level) or Encounter is supported as of now."
+ },
+ {
+ "name": "encounter",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-encounter",
+ "type": "reference",
+ "documentation": "The Encounter level CareTeam are displayed."
+ },
+ {
+ "name": "patient",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careteam-patient",
+ "type": "reference",
+ "documentation": "Who the careteam is for. It is a required field if the _id field is not given."
+ },
+ {
+ "name": "status",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careteam-status",
+ "type": "token",
+ "documentation": "The status of the CareTeam."
+ }
+ ]
+ },
+ {
+ "type": "ChargeItem",
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ }
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "ChargeItem id supports only the single id. It is a required field if the account or context fields are not given."
+ },
+ {
+ "name": "context",
+ "type": "reference",
+ "documentation": "Encounter associated with the ChargeItem. If provided, the '-status' parameter must also be provided. It is a required field if the _id or account fields are not given."
+ },
+ {
+ "name": "account",
+ "type": "reference",
+ "documentation": "Account associated with the ChargeItem. If provided, the '-status' parameter must also be provided. It is a required field if the _id or context fields are not given."
+ },
+ {
+ "name": "-status",
+ "type": "token",
+ "documentation": "The status of the ChargeItem. Must be set to 'billable'. Must be provided with the context and account parameter."
+ },
+ {
+ "name": "_count",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
+ "type": "number",
+ "documentation": "The maximum number of results to return in a page. Not honored when '_id' is set."
+ }
+ ],
+ "operation": [
+ {
+ "name": "credit",
+ "definition": "https://fhir-ehr.cerner.com/r4/OperationDefinition/charge-item-credit",
+ "documentation": "Creates an offsetting ChargeItem for an existing debit ChargeItem."
+ },
+ {
+ "name": "modify",
+ "definition": "https://fhir-ehr.cerner.com/r4/OperationDefinition/charge-item-modify",
+ "documentation": "Modifies an existing ChargeItem resulting in a newly created ChargeItem."
+ },
+ {
+ "name": "create",
+ "definition": "https://fhir-ehr.cerner.com/r4/OperationDefinition/charge-item-create",
+ "documentation": "Creates a charge event which can result in the creation of one or more ChargeItems."
+ }
+ ]
+ },
+ {
+ "type": "Communication",
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ },
+ {
+ "code": "create"
+ },
+ {
+ "code": "patch"
+ }
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of Communication ids. It is a required field if the category, -email-status, received and recipient fields are not given."
+ },
+ {
+ "name": "category",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Communication-category",
+ "type": "token",
+ "documentation": "The message category. It is a required field if the _id field is not given. Must be set with received, recipient and -email-status."
+ },
+ {
+ "name": "received",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Communication-received",
+ "type": "date",
+ "documentation": "When the message is received. It is a required field if the _id field is not given. Must be set with category, recipient and -email-status. If used, the ‘received’ parameter may be provided once or twice. Once with a 'ge' prefix representing the earliest received date, and/or once with a 'le’ prefix representing the latest received date."
+ },
+ {
+ "name": "recipient",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Communication-recipient",
+ "type": "reference",
+ "documentation": "The recipient of the message. It is a required field if the _id field is not given. Must be set with category, recipient and -email-status."
+ },
+ {
+ "name": "-email-status",
+ "type": "token",
+ "documentation": "The email status of the message. It is a required field if the _id field is not given. Must be set with category, received and recipient."
+ }
+ ]
+ },
+ {
+ "type": "Condition",
+ "supportedProfile": [
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
+ ],
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ },
+ {
+ "code": "create"
+ },
+ {
+ "code": "update"
+ }
+ ],
+ "updateCreate": false,
+ "searchRevInclude": [
+ "Provenance:target"
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of Condition ids. It is a required field if the patient or subject fields are not given."
+ },
+ {
+ "name": "patient",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-patient",
+ "type": "reference",
+ "documentation": "Who has the condition. It is a required field if the subject or _id fields are not given."
+ },
+ {
+ "name": "encounter",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Condition-encounter",
+ "type": "reference",
+ "documentation": "The encounter of the patient. Only encounter-diagnosis are returned."
+ },
+ {
+ "name": "subject",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Condition-subject",
+ "type": "reference",
+ "documentation": "Who has the condition. It is a required field if the patient or _id fields are not given."
+ },
+ {
+ "name": "clinical-status",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-clinical-status",
+ "type": "token",
+ "documentation": "The clinical status of the condition."
+ },
+ {
+ "name": "category",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-category",
+ "type": "token",
+ "documentation": "The category of the condition. Categories problem-list-item, encounter-diagnosis and health-concern are supported as of now."
+ }
+ ]
+ },
+ {
+ "type": "Consent",
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ }
+ ],
+ "searchInclude": [
+ "Consent:actor",
+ "Consent:patient"
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of Consent ids."
+ },
+ {
+ "name": "patient",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-patient",
+ "type": "reference",
+ "documentation": "Who the consent applies to. It is a required field if the _id field is not given."
+ },
+ {
+ "name": "actor",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Consent-actor",
+ "type": "reference",
+ "documentation": "Resource for the actor (or group, by role). It is a required field if the _id field is not given."
+ },
+ {
+ "name": "patient.identifier",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Consent-patient.identifier",
+ "type": "token",
+ "documentation": "The patient.identifier allows to search by patient aliases. Federated Person Principle, SSN, MRN etc... are supported as of now. It is a required field if the _id field is not given."
+ },
+ {
+ "name": "actor.identifier",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Consent-actor.identifier",
+ "type": "token",
+ "documentation": "The actor.identifier allows to search by related person aliases. Federated Person Principle is the only supported alias as of now. It is a required field if the _id field is not given."
+ }
+ ]
+ },
+ {
+ "type": "Coverage",
+ "interaction": [
+ {
+ "code": "search-type"
+ },
+ {
+ "code": "create"
+ },
+ {
+ "code": "patch"
+ },
+ {
+ "code": "delete"
+ }
+ ],
+ "searchParam": [
+ {
+ "name": "patient",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Coverage-patient",
+ "type": "reference",
+ "documentation": "Retrieve coverages for a patient."
+ },
+ {
+ "name": "-encounter",
+ "type": "reference",
+ "documentation": "Retrieve coverages for an encounter."
+ }
+ ]
+ },
+ {
+ "type": "Device",
+ "supportedProfile": [
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device"
+ ],
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ }
+ ],
+ "searchRevInclude": [
+ "Provenance:target"
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of Device ids. It is a required field if the patient field is not given."
+ },
+ {
+ "name": "patient",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-device-patient",
+ "type": "reference",
+ "documentation": "The patient to whom Device is affixed. It is a required field if the _id field is not given."
+ }
+ ]
+ },
+ {
+ "type": "DiagnosticReport",
+ "supportedProfile": [
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note",
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab"
+ ],
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ }
+ ],
+ "searchRevInclude": [
+ "Provenance:target"
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of DiagnosticReport ids. It is a required field if the patient field is not given."
+ },
+ {
+ "name": "category",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-category",
+ "type": "token",
+ "documentation": "Which diagnostic discipline/department created the report."
+ },
+ {
+ "name": "code",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-code",
+ "type": "token",
+ "documentation": "The code for the report."
+ },
+ {
+ "name": "encounter",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-encounter",
+ "type": "reference",
+ "documentation": "The Encounter when the report was made."
+ },
+ {
+ "name": "patient",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-patient",
+ "type": "reference",
+ "documentation": "The subject of the report. It is a required field."
+ },
+ {
+ "name": "date",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-date",
+ "type": "date",
+ "documentation": "A date range with which to find Documents. A date parameter may be provided once with or without prefix and time component to imply a date range. Alternately it may be provided twice with 'le', 'lt', 'ge', or 'gt' prefixes and time component to search for procedures within a specific range. The date and prefix pairs must create a closed range. Must be set with patient or subject."
+ },
+ {
+ "name": "_count",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
+ "type": "number",
+ "documentation": "The maximum number of results to return in a page."
+ }
+ ]
+ },
+ {
+ "type": "DocumentReference",
+ "supportedProfile": [
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
+ ],
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ },
+ {
+ "code": "create"
+ },
+ {
+ "code": "update"
+ }
+ ],
+ "updateCreate": false,
+ "searchRevInclude": [
+ "Provenance:target"
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of DocumentReference ids. It is a required field if the patient field is not given."
+ },
+ {
+ "name": "patient",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-patient",
+ "type": "reference",
+ "documentation": "The patient the document is about. It is a required field if the subject field is not given."
+ },
+ {
+ "name": "encounter",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-encounter",
+ "type": "reference",
+ "documentation": "The Encounter in which the document was created."
+ },
+ {
+ "name": "period",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-period",
+ "type": "date",
+ "documentation": "A date range with which to find Documents. If used, the 'period' parameter must be provided twice. Once with a 'ge' prefix representing the earliest date, and once with a 'lt' prefix representing the latest date. The period prefix pair must create a closed range and cannot be equal to each other."
+ },
+ {
+ "name": "_count",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
+ "type": "number",
+ "documentation": "The maximum number of results to return in a page."
+ },
+ {
+ "name": "type",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-type",
+ "type": "token",
+ "documentation": "The kind of document (LOINC if possible)."
+ },
+ {
+ "name": "category",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-category",
+ "type": "token",
+ "documentation": "The categorization of document."
+ },
+ {
+ "name": "date",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-date",
+ "type": "date",
+ "documentation": "It must be provided once with a prefix to imply a date range or without a prefix to search for document(s) at a specific date. Alternately it may be provided twice with `le`, `lt`, `ge`, or `gt` prefixes to search for document(s) within specific range. The date and prefix pairs must create a closed range. For a single 'date' occurrence, `time` component is optional but for two `date` occurrences, must include `time` component."
+ }
+ ],
+ "operation": [
+ {
+ "name": "USCoreFetchDocumentReferences",
+ "definition": "http://hl7.org/fhir/us/core/OperationDefinition/docref",
+ "documentation": "US Core Fetch DocumentReferences"
+ }
+ ]
+ },
+ {
+ "type": "Encounter",
+ "supportedProfile": [
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"
+ ],
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ },
+ {
+ "code": "create"
+ },
+ {
+ "code": "patch"
+ }
+ ],
+ "searchRevInclude": [
+ "Provenance:target"
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of Encounter ids. It is a required field if the account or identifier or -pageContext or patient or subject fields are not given."
+ },
+ {
+ "name": "_count",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
+ "type": "number",
+ "documentation": "The maximum number of results to return in a page. Not honored when '_id' is set."
+ },
+ {
+ "name": "patient",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-patient",
+ "type": "reference",
+ "documentation": "The patient present at the encounter. It is a required field if the account or _id or identifier or -pageContext or subject fields are not given."
+ },
+ {
+ "name": "subject",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Encounter-subject",
+ "type": "reference",
+ "documentation": "The patient present at the encounter. It is a required field if the account or _id or identifier or -pageContext or patient fields are not given."
+ },
+ {
+ "name": "status",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-status",
+ "type": "token",
+ "documentation": "The status of the encounter. Must be set with patient."
+ },
+ {
+ "name": "date",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-date",
+ "type": "date",
+ "documentation": "A date parameter may be provided once with a prefix and time component to imply a date range. Alternately it may be provided twice with 'le', 'lt', 'ge', or 'gt' prefixes and time component to search for encounters within a specific range. The date and prefix pairs must create a closed range. Must be set with patient or subject."
+ },
+ {
+ "name": "identifier",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-identifier",
+ "type": "token",
+ "documentation": "An encounter's identifier. It is a required field if the account or _id or -pageContext or patient or subject fields are not given."
+ }
+ ]
+ },
+ {
+ "type": "FamilyMemberHistory",
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ },
+ {
+ "code": "create"
+ },
+ {
+ "code": "update"
+ }
+ ],
+ "updateCreate": false,
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of FamilyMemberHistory ids. It is a required field if the patient field is not given."
+ },
+ {
+ "name": "patient",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-patient",
+ "type": "reference",
+ "documentation": "Who the family member history is for. It is a required field if the _id field is not given. It is a required field if the status parameter is provided."
+ },
+ {
+ "name": "status",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/status",
+ "type": "token",
+ "documentation": "The status of the FamilyMemberHistory."
+ }
+ ]
+ },
+ {
+ "type": "Goal",
+ "supportedProfile": [
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal"
+ ],
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ }
+ ],
+ "searchRevInclude": [
+ "Provenance:target"
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "Goal id supports only the single id. It is a required field if the patient field is not given."
+ },
+ {
+ "name": "patient",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-goal-patient",
+ "type": "reference",
+ "documentation": "Who has the goal is for. It is a required field if the _id field is not given."
+ },
+ {
+ "name": "target-date",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-goal-target-date",
+ "type": "date",
+ "documentation": "A date or date range from which to find Goals."
+ }
+ ]
+ },
+ {
+ "type": "Group",
+ "operation": [
+ {
+ "name": "export",
+ "definition": "https://fhir-ehr.cerner.com/r4/OperationDefinition/group-export",
+ "documentation": "Operation to obtain a detailed set of FHIR resources of diverse resource types pertaining to all members of the specified Group"
+ }
+ ]
+ },
+ {
+ "type": "Immunization",
+ "supportedProfile": [
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
+ ],
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ },
+ {
+ "code": "create"
+ },
+ {
+ "code": "update"
+ }
+ ],
+ "updateCreate": false,
+ "searchRevInclude": [
+ "Provenance:target"
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of Immunization ids. It is a required field if the patient field is not given."
+ },
+ {
+ "name": "patient",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-patient",
+ "type": "reference",
+ "documentation": "The patient for the vaccination record. It is a required field if the _id field is not given."
+ },
+ {
+ "name": "date",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-date",
+ "type": "date",
+ "documentation": "Vaccination (non)-Administration Date."
+ },
+ {
+ "name": "target-disease",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-target-disease",
+ "type": "token",
+ "documentation": "A single or comma separated list of target diseases the dose is being administered against."
+ }
+ ]
+ },
+ {
+ "type": "InsurancePlan",
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ }
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of InsurancePlan ids."
+ },
+ {
+ "name": "owned-by",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/InsurancePlan-owned-by",
+ "type": "reference",
+ "documentation": "The organization that is providing the health insurance product."
+ }
+ ]
+ },
+ {
+ "type": "Location",
+ "supportedProfile": [
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-location"
+ ],
+ "interaction": [
+ {
+ "code": "read"
+ },
+ {
+ "code": "search-type"
+ }
+ ],
+ "searchParam": [
+ {
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of Location ids. It is a required field if the -physicalType field is not given"
+ },
+ {
+ "name": "-physicalType",
+ "type": "token",
+ "documentation": "The Location's physical type. It is a required field if the _id field is not given"
+ },
+ {
+ "name": "identifier",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-location-identifier",
+ "type": "token",
+ "documentation": "A location's identifier."
+ },
+ {
+ "name": "address",
+ "type": "string",
+ "documentation": "A (part of the) address of the location"
+ },
+ {
+ "name": "address-city",
+ "type": "string",
+ "documentation": "A city specified in an address. It is a required field if the address-state or address-postalcode fields are not given"
+ },
+ {
+ "name": "address-state",
+ "type": "string",
+ "documentation": "A state specified in an address"
+ },
+ {
+ "name": "address-postalcode",
+ "type": "string",
+ "documentation": "A postal code specified in an address"
+ },
+ {
+ "name": "name",
+ "type": "string",
+ "documentation": "A portion of the location's name or alias"
+ },
+ {
+ "name": "organization",
+ "type": "reference",
+ "documentation": "Searches for locations that are managed by the provided organization"
+ }
+ ]
+ },
+ {
+ "type": "MedicationAdministration",
"interaction": [
{
"code": "read"
},
{
"code": "search-type"
- },
- {
- "code": "create"
- },
- {
- "code": "patch"
}
],
"searchParam": [
@@ -1116,58 +2966,38 @@ Request
"name": "_id",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
"type": "token",
- "documentation": "A single or comma separated list of Appointment ids. Either the '_id' parameter or one of the 'patient', 'practitioner' or 'location' parameters must be set."
- },
- {
- "name": "_count",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
- "type": "number",
- "documentation": "The maximum number of results to return. Not honoured when '_id' is set."
- },
- {
- "name": "date",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/Appointment-date",
- "type": "date",
- "documentation": "A date or date range from which to find appointments. This must be set when using patient, practitioner or location. The 'date' parameter may be provided once without a prefix or time component to imply a date range or once without a prefix and with a time component to search for appointments at a specific time. Alternately it may be provided twice with 'le' and 'gt' prefixes to search for appointments within a specific range. The date prefix pair must create a closed range."
+ "documentation": "A single or comma separated list of MedicationAdministration ids."
},
{
"name": "patient",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/Appointment-patient",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/medicationadministration-patient",
"type": "reference",
- "documentation": "One of the individuals of the appointment is this patient. Either the '_id' parameter or one of the 'patient', 'practitioner' or 'location' parameters must be set."
+ "documentation": "The identity of a patient to list administrations for. It is a required field if the _id field is not given."
},
{
- "name": "practitioner",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/Appointment-practitioner",
- "type": "reference",
- "documentation": "One of the individuals of the appointment is this practitioner. Either the '_id' parameter or one of the 'patient', 'practitioner' or 'location' parameters must be set."
+ "name": "status",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/medicationadministration-status",
+ "type": "token",
+ "documentation": "MedicationAdministration event status."
},
{
- "name": "location",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/Appointment-location",
+ "name": "performer",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/medicationadministration-performer",
"type": "reference",
- "documentation": "This location is listed in the participants of the appointment. Either the '_id' parameter or one of the 'patient', 'practitioner' or 'location' parameters must be set."
+ "documentation": "The identity of the individual who administered the medication."
},
{
- "name": "status",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/Appointment-status",
- "type": "token",
- "documentation": "The overall status of the appointment."
- }
- ]
- },
- {
- "type": "Basic",
- "interaction": [
- {
- "code": "create"
+ "name": "effective-time",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/medicationadministration-effective-time",
+ "type": "date",
+ "documentation": "A effective-time parameter may be provided once with 'le' or 'lt' or 'ge' or 'gt' prefix and time component to imply a date range. Alternately it may be provided twice with 'le', 'lt', 'ge', or 'gt' prefixes and time component to search for medications administered within a specific range. The date and prefix pairs must create a closed range."
}
]
},
{
- "type": "CarePlan",
+ "type": "MedicationRequest",
"supportedProfile": [
- "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"
],
"interaction": [
{
@@ -1175,6 +3005,12 @@ Request
},
{
"code": "search-type"
+ },
+ {
+ "code": "create"
+ },
+ {
+ "code": "patch"
}
],
"searchRevInclude": [
@@ -1185,39 +3021,48 @@ Request
"name": "_id",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
"type": "token",
- "documentation": "A single or comma separated list of CarePlan ids."
- },
- {
- "name": "date",
- "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-date",
- "type": "date",
- "documentation": "A date range with which to find CarePlans. If used, the ‘date’\n parameter must be provided twice. Once with a 'ge' prefix representing the earliest date,\n and once with a 'le’ prefix representing the latest date. The date prefix pair must create\n a closed range."
+ "documentation": "A single or comma separated list of MedicationRequest ids."
},
{
"name": "patient",
- "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-patient",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-patient",
"type": "reference",
- "documentation": "Who the careplan is for. It is a required field if the _id field is not given."
+ "documentation": "The patient to return MedicationRequests for. It is a required field if the _id field is not given."
},
{
- "name": "category",
- "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-category",
+ "name": "intent",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-intent",
"type": "token",
- "documentation": "The category of the careplan. Category assess-plan is supported as of now."
+ "documentation": "The intent of the MedicationRequest."
+ },
+ {
+ "name": "status",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-status",
+ "type": "token",
+ "documentation": "The status of the MedicationRequest."
+ },
+ {
+ "name": "_lastUpdated",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-lastUpdated",
+ "type": "date",
+ "documentation": "When the resource version last changed."
+ },
+ {
+ "name": "-timing-boundsPeriod",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-dosageInstruction-timing-repeat-boundsPeriod",
+ "type": "date",
+ "documentation": "The date-time within the period the medication should be given to the patient. Must be prefixed by 'ge'."
},
{
"name": "_count",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
"type": "number",
- "documentation": "The maximum number of results to return. Not honored when '_id' is set."
+ "documentation": "The maximum number of results to return in a page. Not honored when '_id' is set."
}
]
},
{
- "type": "CareTeam",
- "supportedProfile": [
- "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam"
- ],
+ "type": "NutritionOrder",
"interaction": [
{
"code": "read"
@@ -1226,46 +3071,57 @@ Request
"code": "search-type"
}
],
- "searchRevInclude": [
- "Provenance:target"
- ],
"searchParam": [
{
"name": "_id",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
"type": "token",
- "documentation": "CareTeam id supports only the single id. It is a required field if\n the patient or encounter fields are not given."
- },
- {
- "name": "category",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/CareTeam-category",
- "type": "token",
- "documentation": "The category of the careteam. Category Longitudinal (patient level)\n or Encounter is supported as of now."
- },
- {
- "name": "encounter",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-encounter",
- "type": "reference",
- "documentation": "The Encounter level CareTeam are displayed."
+ "documentation": "A single or comma separated list of NutritionOrder ids."
},
{
"name": "patient",
- "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careteam-patient",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-patient",
"type": "reference",
- "documentation": "Who the careteam is for. It is a required field if the _id field is not given."
+ "documentation": "The patient to return NutritionOrders for. It is a required field if the _id field is not given."
},
{
"name": "status",
- "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careteam-status",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/NutritionOrder-status",
"type": "token",
- "documentation": "The status of the CareTeam."
+ "documentation": "The status of the NutritionOrder."
+ },
+ {
+ "name": "_lastUpdated",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-lastUpdated",
+ "type": "date",
+ "documentation": "When the resource version last changed."
+ },
+ {
+ "name": "_count",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
+ "type": "number",
+ "documentation": "The maximum number of results to return in a page. Not honored when '_id' is set."
}
]
},
{
- "type": "Condition",
+ "type": "Observation",
"supportedProfile": [
- "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab",
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-bmi",
+ "http://hl7.org/fhir/us/core/StructureDefinition/pediatric-weight-for-height",
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry",
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus",
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-blood-pressure",
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-height",
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-weight",
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-heart-rate",
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-respiratory-rate",
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-temperature",
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-head-circumference",
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs",
+ "http://hl7.org/fhir/us/core/StructureDefinition/pediatric-bmi-for-age",
+ "http://hl7.org/fhir/us/core/StructureDefinition/head-occipital-frontal-circumference-percentile"
],
"interaction": [
{
@@ -1282,62 +3138,72 @@ Request
}
],
"updateCreate": false,
+ "searchRevInclude": [
+ "Provenance:target"
+ ],
"searchParam": [
{
"name": "_id",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
"type": "token",
- "documentation": "A single or comma separated list of Condition ids. It is a required field if the patient or subject fields are not given."
+ "documentation": "A single or comma separated list of Observation ids. It is a required field if the patient field is not given."
},
{
"name": "patient",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-patient",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-patient",
"type": "reference",
- "documentation": "Who has the condition. It is a required field if the subject or _id fields are not given."
+ "documentation": "The patient the observation is about. It is a required field if the subject field is not given."
},
{
"name": "subject",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/Condition-subject",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Observation-subject",
"type": "reference",
- "documentation": "Who has the condition. It is a required field if the patient or _id fields are not given."
+ "documentation": "The patient subject the observation is about. It is a required field if the patient field is not given."
},
{
- "name": "clinical-status",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/Condition-clinical-status",
+ "name": "category",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-category",
"type": "token",
- "documentation": "The clinical status of the condition."
+ "documentation": "A single or comma separated list of classifications of the type of observation."
},
{
- "name": "category",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/Condition-category",
+ "name": "code",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-code",
"type": "token",
- "documentation": "The category of the condition. Categories problem-list-item and encounter-diagnosis are supported as of now."
+ "documentation": "A single or comma separated list of observation types."
+ },
+ {
+ "name": "date",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-date",
+ "type": "date",
+ "documentation": "A date or date range from which to find observations. The 'date' parameter may be provided once without a prefix or time component to imply a date range or once without a prefix and with a time component to search for observations at a specific time. Alternately it may be provided twice with 'le', 'lt', 'ge', or 'gt' prefixes to search for observations within a specific range. The date and prefix pairs must create a closed range."
+ },
+ {
+ "name": "_lastUpdated",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-lastUpdated",
+ "type": "date",
+ "documentation": "A date or date range used to search for observations which were last updated in that period. The '_lastUpdated' parameter may be provided once without a prefix or time component to imply a date range or once without a prefix and with a time component to search for observations at a specific time. Alternately it may be provided twice with 'le', 'lt', 'ge', or 'gt' prefixes to search for observations within a specific range. The date and prefix pairs must create a closed range."
+ },
+ {
+ "name": "_count",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
+ "type": "number",
+ "documentation": "The maximum number of results to return in a page."
}
]
},
{
- "type": "Coverage",
+ "type": "OperationDefinition",
"interaction": [
{
- "code": "search-type"
- },
- {
- "code": "create"
- }
- ],
- "searchParam": [
- {
- "name": "patient",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/Coverage-patient",
- "type": "reference",
- "documentation": "Retrieve coverages for a patient."
+ "code": "read"
}
]
},
{
- "type": "Device",
+ "type": "Organization",
"supportedProfile": [
- "http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device"
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
],
"interaction": [
{
@@ -1345,6 +3211,9 @@ Request
},
{
"code": "search-type"
+ },
+ {
+ "code": "create"
}
],
"searchParam": [
@@ -1352,20 +3221,51 @@ Request
"name": "_id",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
"type": "token",
- "documentation": "A single or comma separated list of Device ids. It is a required field if the patient field is not given."
+ "documentation": "A single or comma separated list of Organization ids."
},
{
- "name": "patient",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/Device-patient",
- "type": "reference",
- "documentation": "The patient to whom Device is affixed. It is a required field if the _id field is not given."
+ "name": "identifier",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Organization-identifier",
+ "type": "token",
+ "documentation": "The Organization's Identifier."
+ },
+ {
+ "name": "type",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Organization-type",
+ "type": "token",
+ "documentation": "The Organization's type."
+ },
+ {
+ "name": "_count",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Organization-count",
+ "type": "number",
+ "documentation": "The maximum number of results to return in a page."
+ },
+ {
+ "name": "name",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Organization-name",
+ "type": "string",
+ "documentation": "The Organization's name."
+ },
+ {
+ "name": "address",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Organization-address",
+ "type": "string",
+ "documentation": "The Organization's address."
+ }
+ ],
+ "operation": [
+ {
+ "name": "get-cg-for-mrcu",
+ "definition": "https://fhir-ehr.cerner.com/r4/OperationDefinition/organization-get-cg-for-mrcu",
+ "documentation": "Retrieves details for a caregiver organization given a care unit organization id."
}
]
},
{
- "type": "DocumentReference",
+ "type": "Patient",
"supportedProfile": [
- "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
],
"interaction": [
{
@@ -1378,75 +3278,117 @@ Request
"code": "create"
},
{
- "code": "update"
+ "code": "patch"
}
],
- "updateCreate": false,
"searchRevInclude": [
"Provenance:target"
],
"searchParam": [
{
"name": "_id",
- "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-id",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-id",
"type": "token",
- "documentation": "A single or comma separated list of DocumentReference ids. It is a\n required field if the patient field is not given."
+ "documentation": "A single or comma separated list of Patient ids. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided."
},
{
- "name": "patient",
- "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-patient",
- "type": "reference",
- "documentation": "The patient the document is about. It is a required field if the\n subject field is not given."
+ "name": "identifier",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-identifier",
+ "type": "token",
+ "documentation": "A patient identifier. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided."
},
{
- "name": "encounter",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-encounter",
- "type": "reference",
- "documentation": "The Encounter in which the document was created."
+ "name": "name",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-name",
+ "type": "string",
+ "documentation": "The beginning of any name of the patient. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided."
},
{
- "name": "period",
- "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-period",
+ "name": "given",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-given",
+ "type": "string",
+ "documentation": "The beginning of the given name of the patient. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided."
+ },
+ {
+ "name": "family",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-family",
+ "type": "string",
+ "documentation": "The beginning of the family name of the patient. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided."
+ },
+ {
+ "name": "address-postalcode",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/individual-address-postalcode",
+ "type": "string",
+ "documentation": "The postal code of the address of the patient. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided."
+ },
+ {
+ "name": "birthdate",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-birthdate",
"type": "date",
- "documentation": "A date range with which to find Documents. If used, the 'period' parameter\n must be provided twice. Once with a 'ge' prefix representing the earliest date, and once with\n a 'lt' prefix representing the latest date. The period prefix pair must create a closed range\n and cannot be equal to each other."
+ "documentation": "The date of birth of the patient. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided."
},
{
- "name": "_count",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
- "type": "number",
- "documentation": "The maximum number of results to return in a page."
+ "name": "phone",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/individual-phone",
+ "type": "token",
+ "documentation": "The value of the phone number of the patient. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided."
},
{
- "name": "type",
- "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-type",
+ "name": "email",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/individual-email",
"type": "token",
- "documentation": "The kind of document (LOINC if possible)."
+ "documentation": "The value of the email address of the patient. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided."
+ },
+ {
+ "name": "gender",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-gender",
+ "type": "token",
+ "documentation": "The administrative gender of the patient. Gender may only be provided if another parameter other than '_id' is provided"
},
{
- "name": "category",
- "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-category",
- "type": "token",
- "documentation": "The categorization of document."
+ "name": "_count",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
+ "type": "number",
+ "documentation": "The maximum number of results to return in a page. Not honored when '_id' or 'identifier' are set."
+ }
+ ],
+ "operation": [
+ {
+ "name": "health-cards-issue",
+ "definition": "https://spec.smarthealth.cards/artifacts/operation-patient-i-health-cards-issue.json",
+ "documentation": "Issues verifiable health cards for the patient."
+ }
+ ]
+ },
+ {
+ "type": "Person",
+ "interaction": [
+ {
+ "code": "read"
},
{
- "name": "date",
- "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-date",
- "type": "date",
- "documentation": "A date parameter may be provided once with a prefix and time component to\n imply a date range. Alternately it may be provided twice with 'le', 'lt', 'ge', or 'gt' prefixes and\n time component to search for procedures within a specific range. The date and prefix pairs must create\n a closed range. Must be set with patient."
+ "code": "search-type"
}
],
- "operation": [
+ "searchParam": [
{
- "name": "USCoreFetchDocumentReferences",
- "definition": "http://hl7.org/fhir/us/core/OperationDefinition/docref",
- "documentation": "US Core Fetch DocumentReferences"
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of Person ids. It is a required field if the identifier field is not given"
+ },
+ {
+ "name": "identifier",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Person-identifier",
+ "type": "token",
+ "documentation": "A person's Identifier. It is a required field if the _id field is not given"
}
]
},
{
- "type": "Encounter",
+ "type": "Practitioner",
"supportedProfile": [
- "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"
],
"interaction": [
{
@@ -1457,9 +3399,6 @@ Request
},
{
"code": "create"
- },
- {
- "code": "patch"
}
],
"searchParam": [
@@ -1467,32 +3406,50 @@ Request
"name": "_id",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
"type": "token",
- "documentation": "A single or comma separated list of Encounter ids. It is a required field if the patient or subject fields are not given."
+ "documentation": "A single or comma separated list of Practitioner ids. Either the '_id', 'identifier', 'name', 'active' or 'family' parameter, or a combination of 'given' and 'family' parameters must be provided."
},
{
- "name": "_count",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
- "type": "number",
- "documentation": "The maximum number of results to return. Not honored when '_id' is set."
+ "name": "identifier",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-practitioner-identifier",
+ "type": "token",
+ "documentation": "A practitioner's Identifier. Either the '_id', 'identifier', 'name', 'active' or 'family' parameter, or a combination of 'given' and 'family' parameters must be provided."
},
{
- "name": "patient",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-patient",
- "type": "reference",
- "documentation": "The patient present at the encounter. It is a required field if the _id or subject fields are not given."
+ "name": "given",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/individual-given",
+ "type": "string",
+ "documentation": "The beginning of the given name of the practitioner. Either the '_id', 'identifier', 'name', 'active' or 'family' parameter, or a combination of 'given' and 'family' parameters must be provided."
},
{
- "name": "subject",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/Encounter-subject",
- "type": "reference",
- "documentation": "The patient present at the encounter. It is a required field if the _id or patient fields are not given."
+ "name": "family",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/individual-family",
+ "type": "string",
+ "documentation": "The beginning of the family name of the practitioner. Either the '_id', 'identifier', 'name', 'active' or 'family' parameter, or a combination of 'given' and 'family' parameters must be provided."
+ },
+ {
+ "name": "name",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/individual-name",
+ "type": "string",
+ "documentation": "The beginning of the first, last or middle name of the practitioner. Either the '_id', 'identifier', 'name', 'active' or 'family' parameter, or a combination of 'given' and 'family' parameters must be provided."
+ },
+ {
+ "name": "active",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-active",
+ "type": "token",
+ "documentation": "Whether the practitioner record is active. Either the '_id', 'identifier', 'name', 'active' or 'family' parameter, or a combination of 'given' and 'family' parameters must be provided."
+ },
+ {
+ "name": "_count",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
+ "type": "number",
+ "documentation": "The maximum number of results to return in a page. Not honored when '_id' is set. Either the '_id', 'identifier', 'name', 'active' or 'family' parameter, or a combination of 'given' and 'family' parameters must be provided."
}
]
},
{
- "type": "Goal",
+ "type": "Procedure",
"supportedProfile": [
- "http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal"
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
],
"interaction": [
{
@@ -1500,6 +3457,9 @@ Request
},
{
"code": "search-type"
+ },
+ {
+ "code": "create"
}
],
"searchRevInclude": [
@@ -1510,26 +3470,32 @@ Request
"name": "_id",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
"type": "token",
- "documentation": "Goal id supports only the single id. It is a required field if the patient\n field is not given."
+ "documentation": "A single or comma separated list of Procedure ids. It is a required field if the patient or subject fields are not given"
},
{
"name": "patient",
- "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-goal-patient",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-patient",
"type": "reference",
- "documentation": "Who has the goal is for. It is a required field if the _id field is not given."
+ "documentation": "Search by subject - a patient. It is a required field if the _id or subject fields are not given"
},
{
- "name": "target-date",
- "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-goal-target-date",
+ "name": "subject",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-patient",
+ "type": "reference",
+ "documentation": "Search by subject. It is a required field if the _id or patient fields are not given"
+ },
+ {
+ "name": "date",
+ "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-date",
"type": "date",
- "documentation": "A date or date range from which to find Goals."
+ "documentation": "A date parameter may be provided once without a prefix or time component to imply a date range or once without a prefix and with a time component. Alternately it may be provided twice with 'le', 'lt', 'ge', or 'gt' prefixes to search for procedures within a specific range. The date and prefix pairs must create a closed range. Must be set with patient or subject."
}
]
},
{
- "type": "Immunization",
+ "type": "Provenance",
"supportedProfile": [
- "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
+ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance"
],
"interaction": [
{
@@ -1537,6 +3503,9 @@ Request
},
{
"code": "search-type"
+ },
+ {
+ "code": "create"
}
],
"searchParam": [
@@ -1544,27 +3513,18 @@ Request
"name": "_id",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
"type": "token",
- "documentation": "A single or comma separated list of Immunization ids. It is a required field if the patient field is not given."
+ "documentation": "A single or comma separated list of Provenance ids. It is a required field if the target field is not given"
},
{
- "name": "patient",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-patient",
+ "name": "target",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Provenance-target",
"type": "reference",
- "documentation": "The patient for the vaccination record. It is a required field if the _id field is not given."
- },
- {
- "name": "date",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-date",
- "type": "date",
- "documentation": "Vaccination (non)-Administration Date."
+ "documentation": "The resource(s) the Provenance is associated with. It is a required field if the _id field is not given"
}
]
},
{
- "type": "Location",
- "supportedProfile": [
- "http://hl7.org/fhir/us/core/StructureDefinition/us-core-location"
- ],
+ "type": "Questionnaire",
"interaction": [
{
"code": "read"
@@ -1578,64 +3538,41 @@ Request
"name": "_id",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
"type": "token",
- "documentation": "A single or comma separated list of Location ids. It is a required\n field if the -physicalType field is not given"
- },
- {
- "name": "-physicalType",
- "type": "token",
- "documentation": "The Location's physical type. It is a required field if the _id field is not given"
- },
- {
- "name": "identifier",
- "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-location-identifier",
- "type": "token",
- "documentation": "A location's identifier."
- },
- {
- "name": "address",
- "type": "string",
- "documentation": "A (part of the) address of the location"
- },
+ "documentation": "A single or comma separated list of Questionnaire ids."
+ }
+ ]
+ },
+ {
+ "type": "QuestionnaireResponse",
+ "interaction": [
{
- "name": "address-city",
- "type": "string",
- "documentation": "A city specified in an address. It is a required field if the address-state or\n address-postalcode fields are not given"
+ "code": "read"
},
{
- "name": "address-state",
- "type": "string",
- "documentation": "A state specified in an address"
+ "code": "search-type"
},
{
- "name": "address-postalcode",
- "type": "string",
- "documentation": "A postal code specified in an address"
- },
+ "code": "update"
+ }
+ ],
+ "updateCreate": false,
+ "searchParam": [
{
- "name": "name",
- "type": "string",
- "documentation": "A portion of the location's name or alias"
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of QuestionnaireResponse ids. It is a required field if the patient field is not given."
},
{
- "name": "organization",
+ "name": "patient",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/QuestionnaireResponse-patient",
"type": "reference",
- "documentation": "Searches for locations that are managed by the provided organization"
- }
- ]
- },
- {
- "type": "OperationDefinition",
- "interaction": [
- {
- "code": "read"
+ "documentation": "The patient that is the subject of the questionnaire response. It is a required field if the _id field is not given"
}
]
},
{
- "type": "Patient",
- "supportedProfile": [
- "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
- ],
+ "type": "RelatedPerson",
"interaction": [
{
"code": "read"
@@ -1655,75 +3592,53 @@ Request
"name": "_id",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
"type": "token",
- "documentation": "A single or comma separated list of Patient ids. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided."
+ "documentation": "A single or comma separated list of RelatedPerson ids. It is a required field if the identifier or patient or -encounter fields are not given."
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Patient-identifier",
"type": "token",
- "documentation": "A patient identifier. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided."
- },
- {
- "name": "name",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/Patient-name",
- "type": "string",
- "documentation": "The beginning of any name of the patient. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided."
+ "documentation": "An Identifier of the RelatedPerson. It is a required field if the id or patient or -encounter fields are not given"
},
{
- "name": "given",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/individual-given",
- "type": "string",
- "documentation": "The beginning of the given name of the patient. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided."
- },
- {
- "name": "family",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/individual-family",
- "type": "string",
- "documentation": "The beginning of the family name of the patient. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided."
- },
- {
- "name": "address-postalcode",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/individual-address-postalcode",
- "type": "string",
- "documentation": "The postal code of the address of the patient. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided."
+ "name": "patient",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-patient",
+ "type": "reference",
+ "documentation": "The patient this related person is related to. It is a required field if the id or identifier or -encounter fields are not given"
},
{
- "name": "birthdate",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/individual-birthdate",
- "type": "date",
- "documentation": "The date of birth of the patient. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided."
+ "name": "-encounter",
+ "type": "reference",
+ "documentation": "The encounter this related person is related to. It is a required field if the id or identifier or patient fields are not given"
},
{
- "name": "phone",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/individual-phone",
+ "name": "-relationship-level",
"type": "token",
- "documentation": "The value of the phone number of the patient. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided."
- },
+ "documentation": "The resource's relationship to either the patient or encounter level. Must be provided with Patient and Identifier searches."
+ }
+ ]
+ },
+ {
+ "type": "Schedule",
+ "interaction": [
{
- "name": "email",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/individual-email",
- "type": "token",
- "documentation": "The value of the email address of the patient. Either the '_id' parameter, or a combination of 'identifier', 'birthdate', 'name', 'given', 'family', 'address-postalcode', 'phone', or 'email' parameters must be provided."
+ "code": "read"
},
{
- "name": "gender",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/individual-gender",
- "type": "token",
- "documentation": "The administrative gender of the patient. Gender may only be provided if another parameter other than '_id' is provided"
- },
+ "code": "search-type"
+ }
+ ],
+ "searchParam": [
{
- "name": "_count",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
- "type": "number",
- "documentation": "The maximum number of results to return. Not honoured when '_id' or 'identifier' are set."
+ "name": "_id",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
+ "type": "token",
+ "documentation": "A single or comma separated list of Schedule ids. The '_id' parameter must be set."
}
]
},
{
- "type": "Practitioner",
- "supportedProfile": [
- "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"
- ],
+ "type": "ServiceRequest",
"interaction": [
{
"code": "read"
@@ -1737,38 +3652,93 @@ Request
"name": "_id",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
"type": "token",
- "documentation": "A single or comma separated list of Practitioner ids."
+ "documentation": "A single or comma separated list of ServiceRequest ids."
+ },
+ {
+ "name": "patient",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-patient",
+ "type": "reference",
+ "documentation": "The patient to return ServiceRequests for. It is a required field if the subject or _id fields are not given."
+ },
+ {
+ "name": "subject",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/ServiceRequest-subject",
+ "type": "reference",
+ "documentation": "Individual or Entity the service is ordered for. It is a required field if the patient or _id fields are not given."
+ },
+ {
+ "name": "code",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-code",
+ "type": "token",
+ "documentation": "What is being requested/ordered."
+ },
+ {
+ "name": "_lastUpdated",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-lastUpdated",
+ "type": "date",
+ "documentation": "When the resource version last changed."
+ },
+ {
+ "name": "_count",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
+ "type": "number",
+ "documentation": "The maximum number of results to return in a page. Not honored when '_id' is set."
}
]
},
{
- "type": "RelatedPerson",
+ "type": "Slot",
"interaction": [
{
"code": "read"
},
{
"code": "search-type"
+ },
+ {
+ "code": "patch"
}
],
+ "searchInclude": [
+ "Slot:schedule",
+ "Schedule:actor:Practitioner"
+ ],
"searchParam": [
{
"name": "_id",
"definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-id",
"type": "token",
- "documentation": "A single or comma separated list of RelatedPerson ids. It is a required field if the identifier or patient fields are not given."
+ "documentation": "A single or comma separated list of Slot ids. Either the '_id' parameter or 'service-type' must be set."
},
{
- "name": "identifier",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/Patient-identifier",
+ "name": "start",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Slot-date",
+ "type": "date",
+ "documentation": "A date or date range from which the slots are to be retrieved. The 'start' parameter is required when service-type, schedule.actor, -location is provided. When provided, must use both 'lt' and 'ge' prefixes to search for slots within a specific range. Time component should be provided for both the instances. The date and prefix pairs must create a closed range."
+ },
+ {
+ "name": "service-type",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Service-type",
"type": "token",
- "documentation": "An Identifier of the RelatedPerson. It is a required field if the id or patient fields are not given"
+ "documentation": "A single or comma separated list of appointment types that can be booked into the slot. Either the '_id' parameter or 'service-type' must be set."
},
{
- "name": "patient",
- "definition": "http://hl7.org/fhir/R4/SearchParameter/clinical-patient",
+ "name": "schedule.actor",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Slot-schedule.actor",
+ "type": "reference",
+ "documentation": "A single or comma separated list of schedule actors. Must be Practitioner actors."
+ },
+ {
+ "name": "-location",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Slot-location",
"type": "reference",
- "documentation": "The patient this related person is related to. It is a required field if the id or identifier fields are not given"
+ "documentation": "A single or comma separated list of Location references."
+ },
+ {
+ "name": "_count",
+ "definition": "http://hl7.org/fhir/R4/SearchParameter/Resource-count",
+ "type": "number",
+ "documentation": "The maximum number of results to return in a page. This value should be in the range [5,200]. If no value is provided, a default page size of 50 will be used."
}
]
},
@@ -1823,26 +3793,26 @@ Request
-
+
-
+
Status: 200 OK
{
"authorization_endpoint": "https://authorization.cerner.com/tenants/ec2458f2-1e24-41c8-b71b-0e701af7583d/protocols/oauth2/profiles/smart-v1/personas/provider/authorize",
"token_endpoint": "https://authorization.cerner.com/tenants/ec2458f2-1e24-41c8-b71b-0e701af7583d/protocols/oauth2/profiles/smart-v1/token",
- "revocation_endpoint": "https://authorization.devcerner.com/tenants/2c400054-42d8-4e74-87b7-80b5bd5fde9f/protocols/oauth2/profiles/smart-v1/token/revoke",
+ "revocation_endpoint": "https://authorization.cerner.com/tenants/ec2458f2-1e24-41c8-b71b-0e701af7583d/protocols/oauth2/profiles/smart-v1/token/revoke",
"token_endpoint_auth_methods_supported": [
"client_secret_basic",
"private_key_jwt"
@@ -1851,12 +3821,18 @@ Request
"RS384",
"ES384"
],
+ "jwks_uri": "https://authorization.cerner.com/jwk",
+ "grant_types_supported": [
+ "authorization_code",
+ "client_credentials"
+ ],
"scopes_supported": [
"launch",
"profile",
"fhirUser",
"openid",
"online_access",
+ "offline_access",
"user/Account.read",
"patient/Account.read",
"system/Account.read",
@@ -1884,12 +3860,27 @@ Request
"user/CareTeam.read",
"patient/CareTeam.read",
"system/CareTeam.read",
+ "user/ChargeItem.read",
+ "patient/ChargeItem.read",
+ "system/ChargeItem.read",
+ "user/ChargeItem.write",
+ "patient/ChargeItem.write",
+ "system/ChargeItem.write",
+ "user/Communication.read",
+ "patient/Communication.read",
+ "system/Communication.read",
+ "user/Communication.write",
+ "patient/Communication.write",
+ "system/Communication.write",
"user/Condition.read",
"patient/Condition.read",
"system/Condition.read",
"user/Condition.write",
"patient/Condition.write",
"system/Condition.write",
+ "user/Consent.read",
+ "patient/Consent.read",
+ "system/Consent.read",
"user/Coverage.read",
"patient/Coverage.read",
"system/Coverage.read",
@@ -1899,6 +3890,9 @@ Request
"user/Device.read",
"patient/Device.read",
"system/Device.read",
+ "user/DiagnosticReport.read",
+ "patient/DiagnosticReport.read",
+ "system/DiagnosticReport.read",
"user/DocumentReference.read",
"patient/DocumentReference.read",
"system/DocumentReference.read",
@@ -1911,12 +3905,29 @@ Request
"user/Encounter.write",
"patient/Encounter.write",
"system/Encounter.write",
+ "user/FamilyMemberHistory.read",
+ "patient/FamilyMemberHistory.read",
+ "system/FamilyMemberHistory.read",
+ "user/FamilyMemberHistory.write",
+ "patient/FamilyMemberHistory.write",
+ "system/FamilyMemberHistory.write",
+ "user/Goal.read",
+ "patient/Goal.read",
+ "system/Goal.read",
"user/Immunization.read",
"patient/Immunization.read",
"system/Immunization.read",
"user/Immunization.write",
"patient/Immunization.write",
"system/Immunization.write",
+ "user/InsurancePlan.read",
+ "patient/InsurancePlan.read",
+ "system/InsurancePlan.read",
+ "user/Location.read",
+ "system/Location.read",
+ "user/MedicationAdministration.read",
+ "patient/MedicationAdministration.read",
+ "system/MedicationAdministration.read",
"user/MedicationRequest.read",
"patient/MedicationRequest.read",
"system/MedicationRequest.read",
@@ -1961,23 +3972,42 @@ Request
"user/Provenance.write",
"patient/Provenance.write",
"system/Provenance.write",
+ "user/Questionnaire.read",
+ "patient/Questionnaire.read",
+ "system/Questionnaire.read",
+ "user/QuestionnaireResponse.read",
+ "patient/QuestionnaireResponse.read",
+ "system/QuestionnaireResponse.read",
+ "user/QuestionnaireResponse.write",
+ "patient/QuestionnaireResponse.write",
+ "system/QuestionnaireResponse.write",
"user/RelatedPerson.read",
"patient/RelatedPerson.read",
"system/RelatedPerson.read",
+ "user/RelatedPerson.write",
+ "patient/RelatedPerson.write",
+ "system/RelatedPerson.write",
"user/Schedule.read",
"patient/Schedule.read",
"system/Schedule.read",
"user/ServiceRequest.read",
"patient/ServiceRequest.read",
"system/ServiceRequest.read",
+ "user/Slot.read",
+ "patient/Slot.read",
+ "system/Slot.read",
+ "user/Slot.write",
+ "patient/Slot.write",
+ "system/Slot.write",
"system/FinancialTransaction.write"
],
"response_types_supported": [
"code"
],
- "management_endpoint": "https://authorization.devcerner.com/tenants/2c400054-42d8-4e74-87b7-80b5bd5fde9f/personas/provider/my-authorizations",
+ "management_endpoint": "https://authorization.cerner.com/tenants/ec2458f2-1e24-41c8-b71b-0e701af7583d/personas/provider/my-authorizations",
"introspection_endpoint": "https://authorization.cerner.com/tokeninfo",
"capabilities": [
+ "authorize-post",
"launch-ehr",
"launch-standalone",
"client-public",
@@ -1988,7 +4018,11 @@ Request
"context-ehr-patient",
"context-ehr-encounter",
"permission-patient",
- "permission-user"
+ "permission-user",
+ "permission-offline",
+ "permission-online",
+ "permission-v1",
+ "health-cards"
]
}
diff --git a/millennium/r4/foundation/documents/document-reference/index.html b/millennium/r4/foundation/documents/document-reference/index.html
index 032c234b8..eb7077c7d 100644
--- a/millennium/r4/foundation/documents/document-reference/index.html
+++ b/millennium/r4/foundation/documents/document-reference/index.html
@@ -574,7 +574,7 @@ Parameters
- When _revinclude is provided in a request to the closed endpoint, the OAuth2 token must include the user/Provenance.read scope. Currently patient/Provenance.read is not supported and hence _revinclude cannot be utilised for patient persona.
+ 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.
Headers