{ "openapi":"3.0.1", "info":{ "description":"These HL7 FHIR R4 APIs allow a registered user to access the Oracle Health EHR data in Oracle Health AI Application Suite for which they are authorized.", "version":"2026.05.18", "title":"FHIR R4 APIs for Oracle Health AI Application Suite", "x-summary":"These HL7 FHIR R4 APIs allow a registered user to access the Oracle Health EHR data in Oracle Health AI Application Suite for which they are authorized." }, "paths":{ "/Practitioner":{ "get":{ "tags":[ "Practitioner" ], "operationId":"PractitionerSearch", "summary":"Get a list of practitioners", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves a list of practitioners that meet the supplied query parameters.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "name":"name", "in":"query", "required":false, "description":"A server-defined search that may match any of the string fields in the HumanName.\n", "schema":{ "type":"string" } }, { "name":"identifier", "in":"query", "required":false, "description":"A practitioner's identifier.\n", "schema":{ "type":"string" } }, { "name":"_id", "in":"query", "required":false, "description":"The logical resource ID.\n", "schema":{ "type":"string" } } ], "responses":{ "200":{ "$ref":"#/components/responses/PractitionerSearch" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Practitioner-get", "x-filename-id":"practitioner-get" } }, "/Practitioner/{id}":{ "get":{ "tags":[ "Practitioner" ], "operationId":"PractitionerRetrieve", "summary":"Get a practitioner by ID", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves an individual practitioner by the associated ID.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "$ref":"#/components/parameters/id" } ], "responses":{ "200":{ "$ref":"#/components/responses/PractitionerRetrieve" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Practitioner-{id}-get", "x-filename-id":"practitioner-id-get" } }, "/ServiceRequest":{ "get":{ "tags":[ "ServiceRequest" ], "operationId":"ServiceRequestSearch", "summary":"Get a list of service requests", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves a list of service requests that meet the supplied query parameters.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "name":"patient", "in":"query", "required":false, "description":"The subject (patient) for whom the service is requested.\n", "schema":{ "type":"string" } }, { "name":"_id", "in":"query", "required":false, "description":"The logical resource ID.\n", "schema":{ "type":"string" } }, { "name":"category", "in":"query", "required":false, "description":"A code that classifies the service for searching, sorting, and display purposes.\n", "schema":{ "type":"string" } }, { "name":"code", "in":"query", "required":false, "description":"A code that identifies a particular service that has been requested.\n", "schema":{ "type":"string" } }, { "name":"authored", "in":"query", "required":false, "description":"When the service request was authored.\n", "schema":{ "type":"string" } }, { "name":"_revinclude", "in":"query", "required":false, "schema":{ "type":"string", "enum":[ "Provenance:target" ] }, "description":"The related Provenance resources to include in the search bundle.\n" } ], "responses":{ "200":{ "$ref":"#/components/responses/ServiceRequestSearch" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"ServiceRequest-get", "x-filename-id":"servicerequest-get" } }, "/ServiceRequest/{id}":{ "get":{ "tags":[ "ServiceRequest" ], "operationId":"ServiceRequestRetrieve", "summary":"Get a service request by ID", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves an individual service request by the associated ID.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "$ref":"#/components/parameters/id" } ], "responses":{ "200":{ "$ref":"#/components/responses/ServiceRequestRetrieve" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"ServiceRequest-{id}-get", "x-filename-id":"servicerequest-id-get" } }, "/Device":{ "get":{ "tags":[ "Device" ], "operationId":"DeviceSearch", "summary":"Get a list of devices", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves a list of devices that meet the supplied query parameters.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "name":"_id", "in":"query", "required":false, "description":"The logical resource ID.\n", "schema":{ "type":"string" } }, { "name":"patient", "in":"query", "required":false, "description":"The patient to whom the device is affixed.\n", "schema":{ "type":"string" } }, { "name":"_revinclude", "in":"query", "required":false, "schema":{ "type":"string", "enum":[ "Provenance:target" ] }, "description":"The related Provenance resources to include in the search bundle.\n" } ], "responses":{ "200":{ "$ref":"#/components/responses/DeviceSearch" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Device-get", "x-filename-id":"device-get" } }, "/Device/{id}":{ "get":{ "tags":[ "Device" ], "operationId":"DeviceRetrieve", "summary":"Get a device by ID", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves an individual device by the associated ID.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "$ref":"#/components/parameters/id" } ], "responses":{ "200":{ "$ref":"#/components/responses/DeviceRetrieve" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Device-{id}-get", "x-filename-id":"device-id-get" } }, "/Observation":{ "get":{ "tags":[ "Observation" ], "operationId":"ObservationSearch", "summary":"Get a list of observations", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves a list of observations that meet the supplied query parameters.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "name":"_id", "in":"query", "required":false, "description":"The logical resource ID.\n", "schema":{ "type":"string" } }, { "name":"patient", "in":"query", "required":false, "description":"Who or what the observation is about.\n", "schema":{ "type":"string" } }, { "name":"category", "in":"query", "required":false, "description":"The classification of the type of observation.\n", "schema":{ "type":"string" } }, { "name":"code", "in":"query", "required":false, "description":"The observation code.\n", "schema":{ "type":"string" } }, { "name":"date", "in":"query", "required":false, "description":"The obtained date and time. If the obtained element is a period, a date within the period.\n", "schema":{ "type":"string" } }, { "name":"_revinclude", "in":"query", "required":false, "schema":{ "type":"string", "enum":[ "Provenance:target" ] }, "description":"The related Provenance resources to include in the search bundle.\n" } ], "responses":{ "200":{ "$ref":"#/components/responses/ObservationSearch" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Observation-get", "x-filename-id":"observation-get" } }, "/Observation/{id}":{ "get":{ "tags":[ "Observation" ], "operationId":"ObservationRetrieve", "summary":"Get an observation by ID", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves an individual observation by the associated ID.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "$ref":"#/components/parameters/id" } ], "responses":{ "200":{ "$ref":"#/components/responses/ObservationRetrieve" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Observation-{id}-get", "x-filename-id":"observation-id-get" } }, "/Organization":{ "get":{ "tags":[ "Organization" ], "operationId":"OrganizationSearch", "summary":"Get a list of organizations", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves a list of organizations that meet the supplied query parameters.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "name":"_id", "in":"query", "required":false, "description":"The logical resource ID.\n", "schema":{ "type":"string" } }, { "name":"name", "in":"query", "required":false, "description":"The organization's name or a portion of the name.\n", "schema":{ "type":"string" } }, { "name":"address", "in":"query", "required":false, "description":"The organization's address or part of the address.\n", "schema":{ "type":"string" } } ], "responses":{ "200":{ "$ref":"#/components/responses/OrganizationSearch" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Organization-get", "x-filename-id":"organization-get" } }, "/Organization/{id}":{ "get":{ "tags":[ "Organization" ], "operationId":"OrganizationRetrieve", "summary":"Get an organization by ID", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves an individual organization by the associated ID.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "$ref":"#/components/parameters/id" } ], "responses":{ "200":{ "$ref":"#/components/responses/OrganizationRetrieve" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Organization-{id}-get", "x-filename-id":"organization-id-get" } }, "/DocumentReference":{ "get":{ "tags":[ "DocumentReference" ], "operationId":"DocumentReferenceSearch", "summary":"Get a list of document references", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves a list of document references that meet the supplied query parameters.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "name":"_id", "in":"query", "required":false, "description":"The logical resource ID.\n", "schema":{ "type":"string" } }, { "name":"patient", "in":"query", "required":false, "description":"Who or what the document is about.\n", "schema":{ "type":"string" } }, { "name":"category", "in":"query", "required":false, "description":"A categorization for the type of document referenced.\n", "schema":{ "type":"string" } }, { "name":"date", "in":"query", "required":false, "description":"When the document reference was created.\n", "schema":{ "type":"string" } }, { "name":"type", "in":"query", "required":false, "description":"The type of document referenced.\n", "schema":{ "type":"string" } }, { "name":"_revinclude", "in":"query", "required":false, "schema":{ "type":"string", "enum":[ "Provenance:target" ] }, "description":"The related Provenance resources to include in the search bundle.\n" } ], "responses":{ "200":{ "$ref":"#/components/responses/DocumentReferenceSearch" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"DocumentReference-get", "x-filename-id":"documentreference-get" } }, "/DocumentReference/$docref":{ "get":{ "tags":[ "DocumentReference" ], "operationId":"DocumentReferenceDocref", "summary":"Get a list of document references with $docref", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves a list of document references for the supplied $docref query parameters.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "name":"patient", "in":"query", "required":false, "description":"Who or what the document is about.\n", "schema":{ "type":"string" } } ], "responses":{ "200":{ "$ref":"#/components/responses/DocumentReferenceSearch" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"DocumentReference-$docref-get", "x-filename-id":"documentreference-docref-get" } }, "/DocumentReference/{id}":{ "get":{ "tags":[ "DocumentReference" ], "operationId":"DocumentReferenceRetrieve", "summary":"Get a document reference by ID", "description":"

Retrieves an individual document reference by the associated ID.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "$ref":"#/components/parameters/id" } ], "responses":{ "200":{ "$ref":"#/components/responses/DocumentReferenceRetrieve" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"DocumentReference-{id}-get", "x-filename-id":"documentreference-id-get" } }, "/RelatedPerson":{ "get":{ "tags":[ "RelatedPerson" ], "operationId":"RelatedPersonSearch", "summary":"Get a list of related persons", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves a list of related persons that meet the supplied query parameters.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "name":"_id", "in":"query", "required":false, "description":"The logical resource ID.\n", "schema":{ "type":"string" } }, { "name":"_revinclude", "in":"query", "required":false, "schema":{ "type":"string", "enum":[ "Provenance:target" ] }, "description":"The related Provenance resources to include in the search bundle.\n" } ], "responses":{ "200":{ "$ref":"#/components/responses/RelatedPersonSearch" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"RelatedPerson-get", "x-filename-id":"relatedperson-get" } }, "/RelatedPerson/{id}":{ "get":{ "tags":[ "RelatedPerson" ], "operationId":"RelatedPersonRetrieve", "summary":"Get a related person by ID", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves an individual related person by the associated ID.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "$ref":"#/components/parameters/id" } ], "responses":{ "200":{ "$ref":"#/components/responses/RelatedPersonRetrieve" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"RelatedPerson-{id}-get", "x-filename-id":"relatedperson-id-get" } }, "/Patient":{ "get":{ "tags":[ "Patient" ], "operationId":"PatientSearch", "summary":"Get a list of patients", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves a list of patients that meet the supplied query parameters.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "name":"_id", "in":"query", "required":false, "description":"The logical resource ID.\n", "schema":{ "type":"string" } }, { "name":"identifier", "in":"query", "required":false, "description":"A patient identifier.\n", "schema":{ "type":"string" } }, { "name":"name", "in":"query", "required":false, "description":"A server-defined search that may match any of the string fields in the HumanName.\n", "schema":{ "type":"string" } }, { "name":"birthdate", "in":"query", "required":false, "description":"The patient's date of birth.\n", "schema":{ "type":"string" } }, { "name":"gender", "in":"query", "required":false, "description":"The gender of the patient.\n", "schema":{ "type":"string" } }, { "name":"_revinclude", "in":"query", "required":false, "schema":{ "type":"string", "enum":[ "Provenance:target" ] }, "description":"The related Provenance resources to include in the search bundle.\n" } ], "responses":{ "200":{ "$ref":"#/components/responses/PatientSearch" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Patient-get", "x-filename-id":"patient-get" } }, "/Patient/{id}":{ "get":{ "tags":[ "Patient" ], "operationId":"PatientRetrieve", "summary":"Get a patient by ID", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves an individual patient by the associated ID.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "$ref":"#/components/parameters/id" } ], "responses":{ "200":{ "$ref":"#/components/responses/PatientRetrieve" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Patient-{id}-get", "x-filename-id":"patient-id-get" } }, "/Goal":{ "get":{ "tags":[ "Goal" ], "operationId":"GoalSearch", "summary":"Get a list of goals", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves a list of goals that meet the supplied query parameters.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "name":"_id", "in":"query", "required":false, "description":"The logical resource ID.\n", "schema":{ "type":"string" } }, { "name":"patient", "in":"query", "required":false, "description":"Who this goal is intended for.\n", "schema":{ "type":"string" } }, { "name":"_revinclude", "in":"query", "required":false, "schema":{ "type":"string", "enum":[ "Provenance:target" ] }, "description":"The related Provenance resources to include in the search bundle.\n" } ], "responses":{ "200":{ "$ref":"#/components/responses/GoalSearch" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Goal-get", "x-filename-id":"goal-get" } }, "/Goal/{id}":{ "get":{ "tags":[ "Goal" ], "operationId":"GoalRetrieve", "summary":"Get a goal by ID", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves an individual goal by the associated ID.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "$ref":"#/components/parameters/id" } ], "responses":{ "200":{ "$ref":"#/components/responses/GoalRetrieve" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Goal-{id}-get", "x-filename-id":"goal-id-get" } }, "/CarePlan":{ "get":{ "tags":[ "CarePlan" ], "operationId":"CarePlanSearch", "summary":"Get a list of care plans", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves a list of care plans that meet the supplied query parameters.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "name":"_id", "in":"query", "required":false, "description":"The logical resource ID.\n", "schema":{ "type":"string" } }, { "name":"patient", "in":"query", "required":false, "description":"Who the care plan is for.\n", "schema":{ "type":"string" } }, { "name":"category", "in":"query", "required":false, "description":"The type of plan.\n", "schema":{ "type":"string" } }, { "name":"_revinclude", "in":"query", "required":false, "schema":{ "type":"string", "enum":[ "Provenance:target" ] }, "description":"The related Provenance resources to include in the search bundle.\n" } ], "responses":{ "200":{ "$ref":"#/components/responses/CarePlanSearch" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"CarePlan-get", "x-filename-id":"careplan-get" } }, "/CarePlan/{id}":{ "get":{ "tags":[ "CarePlan" ], "operationId":"CarePlanRetrieve", "summary":"Get a care plan by ID", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves an individual care plan by the associated ID.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "$ref":"#/components/parameters/id" } ], "responses":{ "200":{ "$ref":"#/components/responses/CarePlanRetrieve" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"CarePlan-{id}-get", "x-filename-id":"careplan-id-get" } }, "/Condition":{ "get":{ "tags":[ "Condition" ], "operationId":"ConditionSearch", "summary":"Get a list of conditions", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves a list of conditions that meet the supplied query parameters.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "name":"_id", "in":"query", "required":false, "description":"The logical resource ID.\n", "schema":{ "type":"string" } }, { "name":"patient", "in":"query", "required":false, "description":"The individual who has the condition.\n", "schema":{ "type":"string" } }, { "name":"category", "in":"query", "required":false, "description":"A category assigned to the condition.\n", "schema":{ "type":"string" } }, { "name":"_revinclude", "in":"query", "required":false, "schema":{ "type":"string", "enum":[ "Provenance:target" ] }, "description":"The related Provenance resources to include in the search bundle.\n" } ], "responses":{ "200":{ "$ref":"#/components/responses/ConditionSearch" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Condition-get", "x-filename-id":"condition-get" } }, "/Condition/{id}":{ "get":{ "tags":[ "Condition" ], "operationId":"ConditionRetrieve", "summary":"Get a condition by ID", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves an individual condition by the associated ID.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "$ref":"#/components/parameters/id" } ], "responses":{ "200":{ "$ref":"#/components/responses/ConditionRetrieve" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Condition-{id}-get", "x-filename-id":"condition-id-get" } }, "/Procedure":{ "get":{ "tags":[ "Procedure" ], "operationId":"ProcedureSearch", "summary":"Get a list of procedures", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves a list of procedures that meet the supplied query parameters.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "name":"_id", "in":"query", "required":false, "description":"The logical resource ID.\n", "schema":{ "type":"string" } }, { "name":"patient", "in":"query", "required":false, "description":"The identity of a patient to list procedures for.\n", "schema":{ "type":"string" } }, { "name":"date", "in":"query", "required":false, "description":"When the procedure was performed.\n", "schema":{ "type":"string" } }, { "name":"_revinclude", "in":"query", "required":false, "description":"The related Provenance resources to include in the search bundle.\n", "schema":{ "type":"string", "enum":[ "Provenance:target" ] } } ], "responses":{ "200":{ "$ref":"#/components/responses/ProcedureSearch" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Procedure-get", "x-filename-id":"procedure-get" } }, "/Procedure/{id}":{ "get":{ "tags":[ "Procedure" ], "operationId":"ProcedureRetrieve", "summary":"Get a procedure by ID", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves an individual procedure by the associated ID.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "$ref":"#/components/parameters/id" } ], "responses":{ "200":{ "$ref":"#/components/responses/ProcedureRetrieve" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Procedure-{id}-get", "x-filename-id":"procedure-id-get" } }, "/MedicationDispense":{ "get":{ "tags":[ "MedicationDispense" ], "operationId":"MedicationDispenseSearch", "summary":"Get a list of medication dispenses", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves a list of medication dispenses that meet the supplied query parameters.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "name":"_id", "in":"query", "required":false, "description":"The logical resource ID.\n", "schema":{ "type":"string" } }, { "name":"patient", "in":"query", "required":false, "description":"The patient who the dispenses are for.\n", "schema":{ "type":"string" } }, { "name":"_revinclude", "in":"query", "required":false, "schema":{ "type":"string", "enum":[ "Provenance:target" ] }, "description":"The related Provenance resources to include in the search bundle.\n" } ], "responses":{ "200":{ "$ref":"#/components/responses/MedicationDispenseSearch" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"MedicationDispense-get", "x-filename-id":"medicationdispense-get" } }, "/MedicationDispense/{id}":{ "get":{ "tags":[ "MedicationDispense" ], "operationId":"MedicationDispenseRetrieve", "summary":"Get a medication dispense by ID", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves an individual medication dispense by the associated ID.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "$ref":"#/components/parameters/id" } ], "responses":{ "200":{ "$ref":"#/components/responses/MedicationDispenseRetrieve" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"MedicationDispense-{id}-get", "x-filename-id":"medicationdispense-id-get" } }, "/CareTeam":{ "get":{ "tags":[ "CareTeam" ], "operationId":"CareTeamSearch", "summary":"Get a list of care teams", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves a list of care teams that meet the supplied query parameters.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "name":"_id", "in":"query", "required":false, "description":"The logical resource ID.\n", "schema":{ "type":"string" } }, { "name":"patient", "in":"query", "required":false, "description":"Who the care team is for.\n", "schema":{ "type":"string" } }, { "name":"status", "in":"query", "required":false, "description":"The current state of the care team.\n", "schema":{ "type":"string" } }, { "name":"_revinclude", "in":"query", "required":false, "schema":{ "type":"string", "enum":[ "Provenance:target" ] }, "description":"The related Provenance resources to include in the search bundle.\n" } ], "responses":{ "200":{ "$ref":"#/components/responses/CareTeamSearch" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"CareTeam-get", "x-filename-id":"careteam-get" } }, "/CareTeam/{id}":{ "get":{ "tags":[ "CareTeam" ], "operationId":"CareTeamRetrieve", "summary":"Get a care team by ID", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves an individual care team by the associated ID.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "$ref":"#/components/parameters/id" } ], "responses":{ "200":{ "$ref":"#/components/responses/CareTeamRetrieve" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"CareTeam-{id}-get", "x-filename-id":"careteam-id-get" } }, "/MedicationRequest":{ "get":{ "tags":[ "MedicationRequest" ], "operationId":"MedicationRequestSearch", "summary":"Get a list of medication requests", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves a list of medication requests that meet the supplied query parameters.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "name":"_id", "in":"query", "required":false, "description":"The logical resource ID.\n", "schema":{ "type":"string" } }, { "name":"patient", "in":"query", "required":false, "description":"The patient who has the prescriptions.\n", "schema":{ "type":"string" } }, { "name":"intent", "in":"query", "required":false, "description":"The intent of the prescriptions.\n", "schema":{ "type":"string" } }, { "name":"status", "in":"query", "required":false, "description":"The status of the prescriptions.\n", "schema":{ "type":"string" } }, { "name":"_revinclude", "in":"query", "required":false, "schema":{ "type":"string", "enum":[ "Provenance:target" ] }, "description":"The related Provenance resources to include in the search bundle.\n" } ], "responses":{ "200":{ "$ref":"#/components/responses/MedicationRequestSearch" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"MedicationRequest-get", "x-filename-id":"medicationrequest-get" } }, "/MedicationRequest/{id}":{ "get":{ "tags":[ "MedicationRequest" ], "operationId":"MedicationRequestRetrieve", "summary":"Get a medication request by ID", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves an individual medication request by the associated ID.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "$ref":"#/components/parameters/id" } ], "responses":{ "200":{ "$ref":"#/components/responses/MedicationRequestRetrieve" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"MedicationRequest-{id}-get", "x-filename-id":"medicationrequest-id-get" } }, "/Binary/{id}":{ "get":{ "tags":[ "Binary" ], "operationId":"BinaryRetrieve", "summary":"Get a binary by ID", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves an individual binary by the associated ID.

\n\n

Headers

\n

Use an Accept header of application/fhir+json to retrieve the JSON Binary resource.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "$ref":"#/components/parameters/id" } ], "responses":{ "200":{ "$ref":"#/components/responses/BinaryRetrieve" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Binary-{id}-get", "x-filename-id":"binary-id-get" } }, "/AllergyIntolerance":{ "get":{ "tags":[ "AllergyIntolerance" ], "operationId":"AllergyIntoleranceSearch", "summary":"Get a list of allergy intolerances", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves a list of allergy intolerances that meet the supplied query parameters.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "name":"_id", "in":"query", "required":false, "description":"The logical resource ID.\n", "schema":{ "type":"string" } }, { "name":"patient", "in":"query", "required":false, "description":"The patient who has the allergy or intolerance.\n", "schema":{ "type":"string" } }, { "name":"_revinclude", "in":"query", "required":false, "schema":{ "type":"string", "enum":[ "Provenance:target" ] }, "description":"The related Provenance resources to include in the search bundle.\n" } ], "responses":{ "200":{ "$ref":"#/components/responses/AllergyIntoleranceSearch" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"AllergyIntolerance-get", "x-filename-id":"allergyintolerance-get" } }, "/AllergyIntolerance/{id}":{ "get":{ "tags":[ "AllergyIntolerance" ], "operationId":"AllergyIntoleranceRetrieve", "summary":"Get an allergy intolerance by ID", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves an individual allergy intolerance by the associated ID.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "$ref":"#/components/parameters/id" } ], "responses":{ "200":{ "$ref":"#/components/responses/AllergyIntoleranceRetrieve" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"AllergyIntolerance-{id}-get", "x-filename-id":"allergyintolerance-id-get" } }, "/Immunization":{ "get":{ "tags":[ "Immunization" ], "operationId":"ImmunizationSearch", "summary":"Get a list of immunizations", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves a list of immunizations that meet the supplied query parameters.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "name":"_id", "in":"query", "required":false, "description":"The logical resource ID.\n", "schema":{ "type":"string" } }, { "name":"patient", "in":"query", "required":false, "description":"The patient who received or did not receive the immunization.\n", "schema":{ "type":"string" } }, { "name":"_revinclude", "in":"query", "required":false, "schema":{ "type":"string", "enum":[ "Provenance:target" ] }, "description":"The related Provenance resources to include in the search bundle.\n" } ], "responses":{ "200":{ "$ref":"#/components/responses/ImmunizationSearch" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Immunization-get", "x-filename-id":"immunization-get" } }, "/Immunization/{id}":{ "get":{ "tags":[ "Immunization" ], "operationId":"ImmunizationRetrieve", "summary":"Get an immunization by ID", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves an individual immunization by the associated ID.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "$ref":"#/components/parameters/id" } ], "responses":{ "200":{ "$ref":"#/components/responses/ImmunizationRetrieve" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Immunization-{id}-get", "x-filename-id":"immunization-id-get" } }, "/Provenance":{ "get":{ "tags":[ "Provenance" ], "operationId":"ProvenanceSearch", "summary":"Get a list of provenances", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves a list of provenances that meet the supplied query parameters.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "name":"_id", "in":"query", "required":false, "description":"The logical resource ID.\n", "schema":{ "type":"string" } } ], "responses":{ "200":{ "$ref":"#/components/responses/ProvenanceSearch" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Provenance-get", "x-filename-id":"provenance-get" } }, "/Provenance/{id}":{ "get":{ "tags":[ "Provenance" ], "operationId":"ProvenanceRetrieve", "summary":"Get a provenance by ID", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves an individual provenance by the associated ID.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "$ref":"#/components/parameters/id" } ], "responses":{ "200":{ "$ref":"#/components/responses/ProvenanceRetrieve" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Provenance-{id}-get", "x-filename-id":"provenance-id-get" } }, "/Location":{ "get":{ "tags":[ "Location" ], "operationId":"LocationSearch", "summary":"Get a list of locations", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves a list of locations that meet the supplied query parameters.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "name":"_id", "in":"query", "required":false, "description":"The logical resource ID.\n", "schema":{ "type":"string" } }, { "name":"name", "in":"query", "required":false, "description":"The location's name or a portion of the name.\n", "schema":{ "type":"string" } }, { "name":"address", "in":"query", "required":false, "description":"The location's address or part of the address.\n", "schema":{ "type":"string" } } ], "responses":{ "200":{ "$ref":"#/components/responses/LocationSearch" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Location-get", "x-filename-id":"location-get" } }, "/Location/{id}":{ "get":{ "tags":[ "Location" ], "operationId":"LocationRetrieve", "summary":"Get a location by ID", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves an individual location by the associated ID.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "$ref":"#/components/parameters/id" } ], "responses":{ "200":{ "$ref":"#/components/responses/LocationRetrieve" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Location-{id}-get", "x-filename-id":"location-id-get" } }, "/QuestionnaireResponse":{ "get":{ "tags":[ "QuestionnaireResponse" ], "operationId":"QuestionnaireResponseSearch", "summary":"Get a list of questionnaire responses", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves a list of questionnaire responses that meet the supplied query parameters.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "name":"_id", "in":"query", "required":false, "description":"The logical resource ID.\n", "schema":{ "type":"string" } }, { "name":"patient", "in":"query", "required":false, "description":"The subject (patient) of the questionnaire response.\n", "schema":{ "type":"string" } }, { "name":"_revinclude", "in":"query", "required":false, "description":"The related Provenance resources to include in the search bundle.\n", "schema":{ "type":"string", "enum":[ "Provenance:target" ] } } ], "responses":{ "200":{ "$ref":"#/components/responses/QuestionnaireResponseSearch" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"QuestionnaireResponse-get", "x-filename-id":"questionnaireresponse-get" } }, "/QuestionnaireResponse/{id}":{ "get":{ "tags":[ "QuestionnaireResponse" ], "operationId":"QuestionnaireResponseRetrieve", "summary":"Get a questionnaire response by ID", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves an individual questionnaire response by the associated ID.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "$ref":"#/components/parameters/id" } ], "responses":{ "200":{ "$ref":"#/components/responses/QuestionnaireResponseRetrieve" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"QuestionnaireResponse-{id}-get", "x-filename-id":"questionnaireresponse-id-get" } }, "/Encounter":{ "get":{ "tags":[ "Encounter" ], "operationId":"EncounterSearch", "summary":"Get a list of encounters", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves a list of encounters that meet the supplied query parameters.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "name":"_id", "in":"query", "required":false, "description":"The logical resource ID.\n", "schema":{ "type":"string" } }, { "name":"patient", "in":"query", "required":false, "description":"The patient present at the encounter.\n", "schema":{ "type":"string" } }, { "name":"date", "in":"query", "required":false, "description":"A date within the encounter's time period.\n", "schema":{ "type":"string" } }, { "name":"_revinclude", "in":"query", "required":false, "schema":{ "type":"string", "enum":[ "Provenance:target" ] }, "description":"The related Provenance resources to include in the search bundle.\n" } ], "responses":{ "200":{ "$ref":"#/components/responses/EncounterSearch" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Encounter-get", "x-filename-id":"encounter-get" } }, "/Encounter/{id}":{ "get":{ "tags":[ "Encounter" ], "operationId":"EncounterRetrieve", "summary":"Get an encounter by ID", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves an individual encounter by the associated ID.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "$ref":"#/components/parameters/id" } ], "responses":{ "200":{ "$ref":"#/components/responses/EncounterRetrieve" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Encounter-{id}-get", "x-filename-id":"encounter-id-get" } }, "/Media/{id}":{ "get":{ "tags":[ "Media" ], "operationId":"MediaRetrieve", "summary":"Get media by ID", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves individual media content by the associated ID.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "$ref":"#/components/parameters/id" } ], "responses":{ "200":{ "$ref":"#/components/responses/MediaRetrieve" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Media-{id}-get", "x-filename-id":"media-id-get" } }, "/Coverage":{ "get":{ "tags":[ "Coverage" ], "operationId":"CoverageSearch", "summary":"Get a list of coverages", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves a list of coverages that meet the supplied query parameters.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "name":"_id", "in":"query", "required":false, "description":"The logical resource ID.\n", "schema":{ "type":"string" } }, { "name":"patient", "in":"query", "required":false, "description":"The covered party.\n", "schema":{ "type":"string" } }, { "name":"_revinclude", "in":"query", "required":false, "schema":{ "type":"string", "enum":[ "Provenance:target" ] }, "description":"The related Provenance resources to include in the search bundle.\n" } ], "responses":{ "200":{ "$ref":"#/components/responses/CoverageSearch" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Coverage-get", "x-filename-id":"coverage-get" } }, "/Coverage/{id}":{ "get":{ "tags":[ "Coverage" ], "operationId":"CoverageRetrieve", "summary":"Get a coverage by ID", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves an individual coverage by the associated ID.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "$ref":"#/components/parameters/id" } ], "responses":{ "200":{ "$ref":"#/components/responses/CoverageRetrieve" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Coverage-{id}-get", "x-filename-id":"coverage-id-get" } }, "/DiagnosticReport":{ "get":{ "tags":[ "DiagnosticReport" ], "operationId":"DiagnosticReportSearch", "summary":"Get a list of diagnostic reports", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves a list of diagnostic reports that meet the supplied query parameters.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "name":"_id", "in":"query", "required":false, "description":"The logical resource ID.\n", "schema":{ "type":"string" } }, { "name":"patient", "in":"query", "required":false, "description":"The subject of the report. Usually, but not always, the subject is a patient.\n", "schema":{ "type":"string" } }, { "name":"category", "in":"query", "required":false, "description":"A code that classifies the clinical discipline, department, or diagnostic service that created the report.\n", "schema":{ "type":"string" } }, { "name":"code", "in":"query", "required":false, "description":"The test, panel, report, or note that was ordered.\n", "schema":{ "type":"string" } }, { "name":"date", "in":"query", "required":false, "description":"The diagnostically relevant time or time period that the report is related to.\n", "schema":{ "type":"string" } }, { "name":"_revinclude", "in":"query", "required":false, "schema":{ "type":"string", "enum":[ "Provenance:target" ] }, "description":"The related Provenance resources to include in the search bundle.\n" } ], "responses":{ "200":{ "$ref":"#/components/responses/DiagnosticReportSearch" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"DiagnosticReport-get", "x-filename-id":"diagnosticreport-get" } }, "/DiagnosticReport/{id}":{ "get":{ "tags":[ "DiagnosticReport" ], "operationId":"DiagnosticReportRetrieve", "summary":"Get a diagnostic report by ID", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves an individual diagnostic report by the associated ID.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "$ref":"#/components/parameters/id" } ], "responses":{ "200":{ "$ref":"#/components/responses/DiagnosticReportRetrieve" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"DiagnosticReport-{id}-get", "x-filename-id":"diagnosticreport-id-get" } }, "/Specimen":{ "get":{ "tags":[ "Specimen" ], "operationId":"SpecimenSearch", "summary":"Get a list of specimens", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves a list of specimens that meet the supplied query parameters.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "name":"_id", "in":"query", "required":false, "description":"The logical resource ID.\n", "schema":{ "type":"string" } } ], "responses":{ "200":{ "$ref":"#/components/responses/SpecimenSearch" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Specimen-get", "x-filename-id":"specimen-get" } }, "/Specimen/{id}":{ "get":{ "tags":[ "Specimen" ], "operationId":"SpecimenRetrieve", "summary":"Get a specimen by ID", "description":"

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

\n\n

Retrieves an individual specimen by the associated ID.

\n", "parameters":[ { "$ref":"#/components/parameters/AuthorizationHeader" }, { "$ref":"#/components/parameters/AcceptHeader" }, { "$ref":"#/components/parameters/id" } ], "responses":{ "200":{ "$ref":"#/components/responses/SpecimenRetrieve" }, "default":{ "$ref":"#/components/responses/OperationOutcome" } }, "x-internal-id":"Specimen-{id}-get", "x-filename-id":"specimen-id-get" } } }, "components":{ "parameters":{ "id":{ "name":"id", "in":"path", "description":"The logical resource ID.", "required":true, "schema":{ "type":"string" } }, "AuthorizationHeader":{ "name":"authorization", "in":"header", "description":"The credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.", "required":true, "schema":{ "type":"string" } }, "AcceptHeader":{ "name":"accept", "in":"header", "description":"

The media type to be requested.

\n

Example: application/fhir+json

\n", "required":true, "schema":{ "type":"string" } } }, "responses":{ "OperationOutcome":{ "description":"An OperationOutcome\ndescribing any error that occurred.\n", "content":{ "application/fhir+json":{ "schema":{ "$ref":"#/components/schemas/OperationOutcome" } } } }, "PractitionerSearch":{ "description":"Successful search response.", "content":{ "application/fhir+json":{ "schema":{ "type":"object", "required":[ "resourceType", "id", "type" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Bundle" ] }, "id":{ "type":"string" }, "type":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/components/schemas/BundleLink" } }, "entry":{ "type":"array", "items":{ "type":"object", "properties":{ "fullUrl":{ "type":"string", "format":"uri" }, "resource":{ "$ref":"#/components/schemas/Practitioner" }, "search":{ "$ref":"#/components/schemas/Search" } } } } } } } } }, "PractitionerRetrieve":{ "description":"Successful retrieve response.", "content":{ "application/fhir+json":{ "schema":{ "$ref":"#/components/schemas/Practitioner" } } } }, "ServiceRequestSearch":{ "description":"Successful search response.", "content":{ "application/fhir+json":{ "schema":{ "type":"object", "required":[ "resourceType", "id", "type" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Bundle" ] }, "id":{ "type":"string" }, "type":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/components/schemas/BundleLink" } }, "entry":{ "type":"array", "items":{ "type":"object", "properties":{ "fullUrl":{ "type":"string", "format":"uri" }, "resource":{ "$ref":"#/components/schemas/ServiceRequest" }, "search":{ "$ref":"#/components/schemas/Search" } } } } } } } } }, "ServiceRequestRetrieve":{ "description":"Successful retrieve response.", "content":{ "application/fhir+json":{ "schema":{ "$ref":"#/components/schemas/ServiceRequest" } } } }, "DeviceSearch":{ "description":"Successful search response.", "content":{ "application/fhir+json":{ "schema":{ "type":"object", "required":[ "resourceType", "id", "type" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Bundle" ] }, "id":{ "type":"string" }, "type":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/components/schemas/BundleLink" } }, "entry":{ "type":"array", "items":{ "type":"object", "properties":{ "fullUrl":{ "type":"string", "format":"uri" }, "resource":{ "$ref":"#/components/schemas/Device" }, "search":{ "$ref":"#/components/schemas/Search" } } } } } } } } }, "DeviceRetrieve":{ "description":"Successful retrieve response.", "content":{ "application/fhir+json":{ "schema":{ "$ref":"#/components/schemas/Device" } } } }, "ObservationSearch":{ "description":"Successful search response.", "content":{ "application/fhir+json":{ "schema":{ "type":"object", "required":[ "resourceType", "id", "type" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Bundle" ] }, "id":{ "type":"string" }, "type":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/components/schemas/BundleLink" } }, "entry":{ "type":"array", "items":{ "type":"object", "properties":{ "fullUrl":{ "type":"string", "format":"uri" }, "resource":{ "$ref":"#/components/schemas/Observation" }, "search":{ "$ref":"#/components/schemas/Search" } } } } } } } } }, "ObservationRetrieve":{ "description":"Successful retrieve response.", "content":{ "application/fhir+json":{ "schema":{ "$ref":"#/components/schemas/Observation" } } } }, "OrganizationSearch":{ "description":"Successful search response.", "content":{ "application/fhir+json":{ "schema":{ "type":"object", "required":[ "resourceType", "id", "type" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Bundle" ] }, "id":{ "type":"string" }, "type":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/components/schemas/BundleLink" } }, "entry":{ "type":"array", "items":{ "type":"object", "properties":{ "fullUrl":{ "type":"string", "format":"uri" }, "resource":{ "$ref":"#/components/schemas/Organization" }, "search":{ "$ref":"#/components/schemas/Search" } } } } } } } } }, "OrganizationRetrieve":{ "description":"Successful retrieve response.", "content":{ "application/fhir+json":{ "schema":{ "$ref":"#/components/schemas/Organization" } } } }, "DocumentReferenceSearch":{ "description":"Successful search response.", "content":{ "application/fhir+json":{ "schema":{ "type":"object", "required":[ "resourceType", "id", "type" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Bundle" ] }, "id":{ "type":"string" }, "type":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/components/schemas/BundleLink" } }, "entry":{ "type":"array", "items":{ "type":"object", "properties":{ "fullUrl":{ "type":"string", "format":"uri" }, "resource":{ "$ref":"#/components/schemas/DocumentReference" }, "search":{ "$ref":"#/components/schemas/Search" } } } } } } } } }, "DocumentReferenceRetrieve":{ "description":"Successful retrieve response.", "content":{ "application/fhir+json":{ "schema":{ "$ref":"#/components/schemas/DocumentReference" } } } }, "RelatedPersonSearch":{ "description":"Successful search response.", "content":{ "application/fhir+json":{ "schema":{ "type":"object", "required":[ "resourceType", "id", "type" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Bundle" ] }, "id":{ "type":"string" }, "type":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/components/schemas/BundleLink" } }, "entry":{ "type":"array", "items":{ "type":"object", "properties":{ "fullUrl":{ "type":"string", "format":"uri" }, "resource":{ "$ref":"#/components/schemas/RelatedPerson" }, "search":{ "$ref":"#/components/schemas/Search" } } } } } } } } }, "RelatedPersonRetrieve":{ "description":"Successful retrieve response.", "content":{ "application/fhir+json":{ "schema":{ "$ref":"#/components/schemas/RelatedPerson" } } } }, "PatientSearch":{ "description":"Successful search response.", "content":{ "application/fhir+json":{ "schema":{ "type":"object", "required":[ "resourceType", "id", "type" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Bundle" ] }, "id":{ "type":"string" }, "type":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/components/schemas/BundleLink" } }, "entry":{ "type":"array", "items":{ "type":"object", "properties":{ "fullUrl":{ "type":"string", "format":"uri" }, "resource":{ "$ref":"#/components/schemas/Patient" }, "search":{ "$ref":"#/components/schemas/Search" } } } } } } } } }, "PatientRetrieve":{ "description":"Successful retrieve response.", "content":{ "application/fhir+json":{ "schema":{ "$ref":"#/components/schemas/Patient" } } } }, "GoalSearch":{ "description":"Successful search response.", "content":{ "application/fhir+json":{ "schema":{ "type":"object", "required":[ "resourceType", "id", "type" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Bundle" ] }, "id":{ "type":"string" }, "type":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/components/schemas/BundleLink" } }, "entry":{ "type":"array", "items":{ "type":"object", "properties":{ "fullUrl":{ "type":"string", "format":"uri" }, "resource":{ "$ref":"#/components/schemas/Goal" }, "search":{ "$ref":"#/components/schemas/Search" } } } } } } } } }, "GoalRetrieve":{ "description":"Successful retrieve response.", "content":{ "application/fhir+json":{ "schema":{ "$ref":"#/components/schemas/Goal" } } } }, "CarePlanSearch":{ "description":"Successful search response.", "content":{ "application/fhir+json":{ "schema":{ "type":"object", "required":[ "resourceType", "id", "type" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Bundle" ] }, "id":{ "type":"string" }, "type":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/components/schemas/BundleLink" } }, "entry":{ "type":"array", "items":{ "type":"object", "properties":{ "fullUrl":{ "type":"string", "format":"uri" }, "resource":{ "$ref":"#/components/schemas/CarePlan" }, "search":{ "$ref":"#/components/schemas/Search" } } } } } } } } }, "CarePlanRetrieve":{ "description":"Successful retrieve response.", "content":{ "application/fhir+json":{ "schema":{ "$ref":"#/components/schemas/CarePlan" } } } }, "ConditionSearch":{ "description":"Successful search response.", "content":{ "application/fhir+json":{ "schema":{ "type":"object", "required":[ "resourceType", "id", "type" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Bundle" ] }, "id":{ "type":"string" }, "type":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/components/schemas/BundleLink" } }, "entry":{ "type":"array", "items":{ "type":"object", "properties":{ "fullUrl":{ "type":"string", "format":"uri" }, "resource":{ "$ref":"#/components/schemas/Condition" }, "search":{ "$ref":"#/components/schemas/Search" } } } } } } } } }, "ConditionRetrieve":{ "description":"Successful retrieve response.", "content":{ "application/fhir+json":{ "schema":{ "$ref":"#/components/schemas/Condition" } } } }, "ProcedureSearch":{ "description":"Successful search response.", "content":{ "application/fhir+json":{ "schema":{ "type":"object", "required":[ "resourceType", "id", "type" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Bundle" ] }, "id":{ "type":"string" }, "type":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/components/schemas/BundleLink" } }, "entry":{ "type":"array", "items":{ "type":"object", "properties":{ "fullUrl":{ "type":"string", "format":"uri" }, "resource":{ "$ref":"#/components/schemas/Procedure" }, "search":{ "$ref":"#/components/schemas/Search" } } } } } } } } }, "ProcedureRetrieve":{ "description":"Successful retrieve response.", "content":{ "application/fhir+json":{ "schema":{ "$ref":"#/components/schemas/Procedure" } } } }, "MedicationDispenseSearch":{ "description":"Successful search response.", "content":{ "application/fhir+json":{ "schema":{ "type":"object", "required":[ "resourceType", "id", "type" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Bundle" ] }, "id":{ "type":"string" }, "type":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/components/schemas/BundleLink" } }, "entry":{ "type":"array", "items":{ "type":"object", "properties":{ "fullUrl":{ "type":"string", "format":"uri" }, "resource":{ "$ref":"#/components/schemas/MedicationDispense" }, "search":{ "$ref":"#/components/schemas/Search" } } } } } } } } }, "MedicationDispenseRetrieve":{ "description":"Successful retrieve response.", "content":{ "application/fhir+json":{ "schema":{ "$ref":"#/components/schemas/MedicationDispense" } } } }, "CareTeamSearch":{ "description":"Successful search response.", "content":{ "application/fhir+json":{ "schema":{ "type":"object", "required":[ "resourceType", "id", "type" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Bundle" ] }, "id":{ "type":"string" }, "type":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/components/schemas/BundleLink" } }, "entry":{ "type":"array", "items":{ "type":"object", "properties":{ "fullUrl":{ "type":"string", "format":"uri" }, "resource":{ "$ref":"#/components/schemas/CareTeam" }, "search":{ "$ref":"#/components/schemas/Search" } } } } } } } } }, "CareTeamRetrieve":{ "description":"Successful retrieve response.", "content":{ "application/fhir+json":{ "schema":{ "$ref":"#/components/schemas/CareTeam" } } } }, "MedicationRequestSearch":{ "description":"Successful search response.", "content":{ "application/fhir+json":{ "schema":{ "type":"object", "required":[ "resourceType", "id", "type" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Bundle" ] }, "id":{ "type":"string" }, "type":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/components/schemas/BundleLink" } }, "entry":{ "type":"array", "items":{ "type":"object", "properties":{ "fullUrl":{ "type":"string", "format":"uri" }, "resource":{ "$ref":"#/components/schemas/MedicationRequest" }, "search":{ "$ref":"#/components/schemas/Search" } } } } } } } } }, "MedicationRequestRetrieve":{ "description":"Successful retrieve response.", "content":{ "application/fhir+json":{ "schema":{ "$ref":"#/components/schemas/MedicationRequest" } } } }, "BinaryRetrieve":{ "description":"Successful retrieve response.", "content":{ "application/fhir+json":{ "schema":{ "$ref":"#/components/schemas/Binary" } } } }, "AllergyIntoleranceSearch":{ "description":"Successful search response.", "content":{ "application/fhir+json":{ "schema":{ "type":"object", "required":[ "resourceType", "id", "type" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Bundle" ] }, "id":{ "type":"string" }, "type":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/components/schemas/BundleLink" } }, "entry":{ "type":"array", "items":{ "type":"object", "properties":{ "fullUrl":{ "type":"string", "format":"uri" }, "resource":{ "$ref":"#/components/schemas/AllergyIntolerance" }, "search":{ "$ref":"#/components/schemas/Search" } } } } } } } } }, "AllergyIntoleranceRetrieve":{ "description":"Successful retrieve response.", "content":{ "application/fhir+json":{ "schema":{ "$ref":"#/components/schemas/AllergyIntolerance" } } } }, "ImmunizationSearch":{ "description":"Successful search response.", "content":{ "application/fhir+json":{ "schema":{ "type":"object", "required":[ "resourceType", "id", "type" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Bundle" ] }, "id":{ "type":"string" }, "type":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/components/schemas/BundleLink" } }, "entry":{ "type":"array", "items":{ "type":"object", "properties":{ "fullUrl":{ "type":"string", "format":"uri" }, "resource":{ "$ref":"#/components/schemas/Immunization" }, "search":{ "$ref":"#/components/schemas/Search" } } } } } } } } }, "ImmunizationRetrieve":{ "description":"Successful retrieve response.", "content":{ "application/fhir+json":{ "schema":{ "$ref":"#/components/schemas/Immunization" } } } }, "ProvenanceSearch":{ "description":"Successful search response.", "content":{ "application/fhir+json":{ "schema":{ "type":"object", "required":[ "resourceType", "id", "type" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Bundle" ] }, "id":{ "type":"string" }, "type":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/components/schemas/BundleLink" } }, "entry":{ "type":"array", "items":{ "type":"object", "properties":{ "fullUrl":{ "type":"string", "format":"uri" }, "resource":{ "$ref":"#/components/schemas/Provenance" }, "search":{ "$ref":"#/components/schemas/Search" } } } } } } } } }, "ProvenanceRetrieve":{ "description":"Successful retrieve response.", "content":{ "application/fhir+json":{ "schema":{ "$ref":"#/components/schemas/Provenance" } } } }, "LocationSearch":{ "description":"Successful search response.", "content":{ "application/fhir+json":{ "schema":{ "type":"object", "required":[ "resourceType", "id", "type" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Bundle" ] }, "id":{ "type":"string" }, "type":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/components/schemas/BundleLink" } }, "entry":{ "type":"array", "items":{ "type":"object", "properties":{ "fullUrl":{ "type":"string", "format":"uri" }, "resource":{ "$ref":"#/components/schemas/Location" }, "search":{ "$ref":"#/components/schemas/Search" } } } } } } } } }, "LocationRetrieve":{ "description":"Successful retrieve response.", "content":{ "application/fhir+json":{ "schema":{ "$ref":"#/components/schemas/Location" } } } }, "QuestionnaireResponseSearch":{ "description":"Successful search response.", "content":{ "application/fhir+json":{ "schema":{ "type":"object", "required":[ "resourceType", "id", "type" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Bundle" ] }, "id":{ "type":"string" }, "type":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/components/schemas/BundleLink" } }, "entry":{ "type":"array", "items":{ "type":"object", "properties":{ "fullUrl":{ "type":"string", "format":"uri" }, "resource":{ "$ref":"#/components/schemas/QuestionnaireResponse" }, "search":{ "$ref":"#/components/schemas/Search" } } } } } } } } }, "QuestionnaireResponseRetrieve":{ "description":"Successful retrieve response.", "content":{ "application/fhir+json":{ "schema":{ "$ref":"#/components/schemas/QuestionnaireResponse" } } } }, "EncounterSearch":{ "description":"Successful search response.", "content":{ "application/fhir+json":{ "schema":{ "type":"object", "required":[ "resourceType", "id", "type" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Bundle" ] }, "id":{ "type":"string" }, "type":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/components/schemas/BundleLink" } }, "entry":{ "type":"array", "items":{ "type":"object", "properties":{ "fullUrl":{ "type":"string", "format":"uri" }, "resource":{ "$ref":"#/components/schemas/Encounter" }, "search":{ "$ref":"#/components/schemas/Search" } } } } } } } } }, "EncounterRetrieve":{ "description":"Successful retrieve response.", "content":{ "application/fhir+json":{ "schema":{ "$ref":"#/components/schemas/Encounter" } } } }, "MediaRetrieve":{ "description":"Successful retrieve response.", "content":{ "application/fhir+json":{ "schema":{ "$ref":"#/components/schemas/Media" } } } }, "CoverageSearch":{ "description":"Successful search response.", "content":{ "application/fhir+json":{ "schema":{ "type":"object", "required":[ "resourceType", "id", "type" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Bundle" ] }, "id":{ "type":"string" }, "type":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/components/schemas/BundleLink" } }, "entry":{ "type":"array", "items":{ "type":"object", "properties":{ "fullUrl":{ "type":"string", "format":"uri" }, "resource":{ "$ref":"#/components/schemas/Coverage" }, "search":{ "$ref":"#/components/schemas/Search" } } } } } } } } }, "CoverageRetrieve":{ "description":"Successful retrieve response.", "content":{ "application/fhir+json":{ "schema":{ "$ref":"#/components/schemas/Coverage" } } } }, "DiagnosticReportSearch":{ "description":"Successful search response.", "content":{ "application/fhir+json":{ "schema":{ "type":"object", "required":[ "resourceType", "id", "type" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Bundle" ] }, "id":{ "type":"string" }, "type":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/components/schemas/BundleLink" } }, "entry":{ "type":"array", "items":{ "type":"object", "properties":{ "fullUrl":{ "type":"string", "format":"uri" }, "resource":{ "$ref":"#/components/schemas/DiagnosticReport" }, "search":{ "$ref":"#/components/schemas/Search" } } } } } } } } }, "DiagnosticReportRetrieve":{ "description":"Successful retrieve response.", "content":{ "application/fhir+json":{ "schema":{ "$ref":"#/components/schemas/DiagnosticReport" } } } }, "SpecimenSearch":{ "description":"Successful search response.", "content":{ "application/fhir+json":{ "schema":{ "type":"object", "required":[ "resourceType", "id", "type" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Bundle" ] }, "id":{ "type":"string" }, "type":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/components/schemas/BundleLink" } }, "entry":{ "type":"array", "items":{ "type":"object", "properties":{ "fullUrl":{ "type":"string", "format":"uri" }, "resource":{ "$ref":"#/components/schemas/Specimen" }, "search":{ "$ref":"#/components/schemas/Search" } } } } } } } } }, "SpecimenRetrieve":{ "description":"Successful retrieve response.", "content":{ "application/fhir+json":{ "schema":{ "$ref":"#/components/schemas/Specimen" } } } } }, "schemas":{ "OperationOutcome":{ "type":"object", "required":[ "resourceType", "issue" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "OperationOutcome" ] }, "issue":{ "type":"array", "items":{ "type":"object", "required":[ "severity", "code" ], "properties":{ "severity":{ "type":"string" }, "code":{ "type":"string" } } } } } }, "BundleLink":{ "type":"object", "properties":{ "relation":{ "type":"string", "enum":[ "self", "next", "previous" ] }, "url":{ "type":"string", "format":"uri" } } }, "Search":{ "type":"object", "properties":{ "mode":{ "type":"string" } } }, "Identifier":{ "type":"object", "required":[ "system", "value" ], "properties":{ "system":{ "type":"string", "format":"uri" }, "value":{ "type":"string" } } }, "HumanName":{ "type":"object", "required":[ "family" ], "properties":{ "family":{ "type":"string", "description":"The family name (often called the surname)." } } }, "ContactPoint":{ "type":"object", "properties":{ "system":{ "type":"string", "description":"(USCDI) The following values are supported:\n \n" }, "value":{ "type":"string", "description":"The actual contact point details." } } }, "Address":{ "type":"object", "properties":{ "line":{ "type":"array", "description":"The street name, number, direction, P.O. Box, and so on.", "items":{ "type":"string" } }, "city":{ "type":"string", "description":"The name of city, town, and so on." }, "state":{ "type":"string", "description":"The subunit of the country (abbreviations are supported)." }, "postalCode":{ "type":"string", "description":"The U.S. ZIP Codes." }, "country":{ "type":"string", "description":"The country, which can be the International Organization for Standardization (ISO) 3166 two-letter or three-letter code." } } }, "Practitioner":{ "type":"object", "required":[ "resourceType", "id", "identifier", "name" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Practitioner" ] }, "id":{ "type":"string" }, "identifier":{ "type":"array", "description":"An identifier for the person as this agent.", "items":{ "$ref":"#/components/schemas/Identifier" } }, "name":{ "type":"array", "description":"The names associated with the practitioner.", "items":{ "$ref":"#/components/schemas/HumanName" } }, "telecom":{ "type":"array", "description":"A contact detail for the practitioner that applies to all roles.", "items":{ "$ref":"#/components/schemas/ContactPoint" } }, "address":{ "type":"array", "description":"The addresses of the practitioner.", "items":{ "$ref":"#/components/schemas/Address" } } } }, "Coding":{ "type":"object", "properties":{ "system":{ "type":"string", "format":"uri" }, "code":{ "type":"string" }, "display":{ "type":"string" } } }, "CodeableConcept":{ "type":"object", "properties":{ "coding":{ "type":"array", "items":{ "$ref":"#/components/schemas/Coding" } }, "text":{ "type":"string" } } }, "Reference":{ "type":"object", "properties":{ "reference":{ "type":"string" }, "type":{ "type":"string" } } }, "Period":{ "type":"object", "properties":{ "start":{ "type":"string", "format":"date-time" }, "end":{ "type":"string", "format":"date-time" } } }, "Timing":{ "type":"object", "properties":{ "event":{ "type":"array", "items":{ "type":"string", "format":"date-time" } } } }, "ServiceRequest":{ "type":"object", "required":[ "resourceType", "id", "status", "intent", "code", "subject" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "ServiceRequest" ] }, "id":{ "type":"string" }, "status":{ "type":"string", "description":"(USCDI) The following values are supported:\n \n" }, "intent":{ "type":"string", "description":"(USCDI) The following values are supported:\n \n" }, "category":{ "type":"array", "description":"(USCDI) The classification of the service.", "items":{ "$ref":"#/components/schemas/CodeableConcept" } }, "code":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"(USCDI) What is being requested or ordered." }, "subject":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) The individual or entity the service is ordered for." }, "occurrenceDateTime":{ "type":"string", "format":"date-time", "description":"(USCDI) When the service should occur." }, "occurrencePeriod":{ "allOf":[ { "$ref":"#/components/schemas/Period" } ], "description":"(USCDI) When the service should occur." }, "occurrenceTiming":{ "allOf":[ { "$ref":"#/components/schemas/Timing" } ], "description":"(USCDI) When the service should occur." }, "authoredOn":{ "type":"string", "format":"date-time", "description":"(USCDI) The date when the request is signed." }, "requester":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) Who or what is requesting service." }, "performer":{ "type":"array", "description":"The requested performer.", "items":{ "$ref":"#/components/schemas/Reference" } }, "reasonCode":{ "type":"array", "description":"(USCDI) The explanation or justification for the procedure or service.", "items":{ "$ref":"#/components/schemas/CodeableConcept" } }, "reasonReference":{ "type":"array", "description":"(USCDI) The U.S. Core profile that supports the requested service.", "items":{ "$ref":"#/components/schemas/Reference" } }, "specimen":{ "type":"array", "description":"The procedure samples.", "items":{ "$ref":"#/components/schemas/Reference" } }, "bodySite":{ "type":"array", "description":"The location on the body.", "items":{ "$ref":"#/components/schemas/CodeableConcept" } } } }, "Device":{ "type":"object", "required":[ "resourceType", "id", "type", "patient" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Device" ] }, "id":{ "type":"string" }, "udiCarrier":{ "type":"array", "description":"(USCDI) The unique device identifier (UDI) barcode string.", "items":{ "$ref":"#/components/schemas/DeviceUdiCarrier" } }, "distinctIdentifier":{ "type":"string", "description":"(USCDI) The distinct identification string." }, "manufactureDate":{ "type":"string", "format":"date-time", "description":"(USCDI) The date when the device was made." }, "expirationDate":{ "type":"string", "format":"date-time", "description":"(USCDI) The date and time of expiry of this device (if applicable)." }, "lotNumber":{ "type":"string", "description":"(USCDI) The manufacture lot number." }, "serialNumber":{ "type":"string", "description":"(USCDI) The serial number assigned by the manufacturer." }, "type":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"(USCDI) The kind or type of device." }, "patient":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) The patient to whom the device is affixed." } } }, "DeviceUdiCarrier":{ "type":"object", "required":[ "deviceIdentifier" ], "properties":{ "deviceIdentifier":{ "type":"string", "description":"(USCDI) The mandatory fixed portion of the UDI." }, "carrierHRF":{ "type":"string", "description":"(USCDI) The UDI carrier's human-readable barcode string." } } }, "Quantity":{ "type":"object", "properties":{ "value":{ "type":"number" }, "unit":{ "type":"string" }, "system":{ "type":"string", "format":"uri" }, "code":{ "type":"string" } } }, "Observation":{ "type":"object", "required":[ "resourceType", "id", "status", "category", "code", "subject" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Observation" ] }, "id":{ "type":"string" }, "status":{ "type":"string", "description":"(USCDI) The status of the result value." }, "category":{ "type":"array", "description":"

(USCDI) A code that classifies the general type of observation being made.

\n

For the following vital sign profiles, category.coding.system is set to http://terminology.hl7.org/CodeSystem/observation-category and category.coding.code is set to vital-signs:\n

\n", "items":{ "$ref":"#/components/schemas/CodeableConcept" } }, "code":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"(USCDI) What was observed." }, "subject":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) Who or what the observation is about." }, "effectiveDateTime":{ "type":"string", "format":"date-time", "description":"(USCDI) The clinically relevant time or time period for the observation." }, "effectivePeriod":{ "allOf":[ { "$ref":"#/components/schemas/Period" } ], "description":"(USCDI) The clinically relevant time or time period for the observation." }, "performer":{ "type":"array", "description":"The individual who is responsible for the observation.", "items":{ "$ref":"#/components/schemas/Reference" } }, "valueQuantity":{ "allOf":[ { "$ref":"#/components/schemas/Quantity" } ], "description":"

(USCDI) The result value as a quantity.

\n\n", "nullable":true }, "valueCodeableConcept":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"(USCDI) The result value as a coded concept.", "nullable":true }, "dataAbsentReason":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"(USCDI) A reason why the expected value is missing." }, "specimen":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) The specimen used for this observation." }, "hasMember":{ "type":"array", "description":"A related resource that belongs to the observation group.", "items":{ "$ref":"#/components/schemas/Reference" } }, "derivedFrom":{ "type":"array", "description":"The related measurements the observation is made from.", "items":{ "$ref":"#/components/schemas/Reference" } }, "component":{ "type":"array", "description":"

(USCDI) The component observations that are part of this observation.

\n

For each component, only one value[x] representation is returned (for example, valueQuantity or valueCodeableConcept).

\n", "items":{ "$ref":"#/components/schemas/ObservationComponent" } } } }, "ObservationComponent":{ "type":"object", "required":[ "code" ], "properties":{ "code":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"(USCDI) The type of component observation." }, "valueQuantity":{ "allOf":[ { "$ref":"#/components/schemas/Quantity" } ], "description":"

(USCDI) The component observation value as a quantity.

\n\n", "nullable":true }, "valueCodeableConcept":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"(USCDI) The component observation value as a coded concept.", "nullable":true }, "dataAbsentReason":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"(USCDI) A reason why the expected component value is missing." } } }, "Organization":{ "type":"object", "required":[ "resourceType", "id", "active", "name" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Organization" ] }, "id":{ "type":"string" }, "identifier":{ "type":"array", "description":"An identifier for this organization across multiple systems.", "items":{ "$ref":"#/components/schemas/Identifier" } }, "active":{ "type":"boolean", "description":"Whether the organization's record is still in active use." }, "name":{ "type":"string", "description":"The name used for the organization." }, "telecom":{ "type":"array", "description":"A contact detail for the organization.", "items":{ "$ref":"#/components/schemas/ContactPoint" } }, "address":{ "type":"array", "description":"An address for the organization.", "items":{ "$ref":"#/components/schemas/Address" } } } }, "Meta":{ "type":"object", "properties":{ "versionId":{ "type":"string" }, "lastUpdated":{ "type":"string", "format":"date-time" } }, "required":[ "versionId", "lastUpdated" ] }, "Narrative":{ "type":"object", "properties":{ "status":{ "type":"string" }, "div":{ "type":"string" } }, "required":[ "status", "div" ] }, "DocumentReference":{ "type":"object", "required":[ "resourceType", "id", "status", "type", "category", "subject", "content" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "DocumentReference" ] }, "id":{ "type":"string" }, "identifier":{ "type":"array", "description":"The other identifiers associated with the document, including version-independent identifiers.", "items":{ "$ref":"#/components/schemas/Identifier" } }, "status":{ "type":"string", "description":"The status of this document reference." }, "type":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"The particular type of document referenced." }, "category":{ "type":"array", "description":"A categorization for the type of document referenced.", "items":{ "$ref":"#/components/schemas/CodeableConcept" } }, "subject":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"Who or what the document is about." }, "date":{ "type":"string", "format":"date-time", "description":"When the document reference was created." }, "author":{ "type":"array", "description":"The individual who is responsible for adding the information to the document.", "items":{ "$ref":"#/components/schemas/Reference" } }, "content":{ "type":"array", "description":"The document and format referenced.", "items":{ "$ref":"#/components/schemas/DocumentReferenceContent" } }, "context":{ "allOf":[ { "$ref":"#/components/schemas/DocumentReferenceContext" } ], "description":"The clinical context in which the document was prepared." } } }, "DocumentReferenceContent":{ "type":"object", "required":[ "attachment" ], "properties":{ "attachment":{ "allOf":[ { "$ref":"#/components/schemas/DocumentReferenceAttachment" } ], "description":"The document or URL of the document with critical metadata to prove that the content has integrity." }, "format":{ "allOf":[ { "$ref":"#/components/schemas/Coding" } ], "description":"An identifier of the document encoding, structure, and template." } } }, "DocumentReferenceAttachment":{ "type":"object", "properties":{ "contentType":{ "type":"string", "description":"The type of data in the attachment that allows a method to be chosen to interpret or render the data." }, "data":{ "type":"string", "description":"The actual data of the attachment, which is base64 encoded." }, "url":{ "type":"string", "format":"uri", "description":"A location where the data can be accessed." } } }, "DocumentReferenceContext":{ "type":"object", "properties":{ "encounter":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"The clinical encounter that the document content is associated with." }, "period":{ "allOf":[ { "$ref":"#/components/schemas/Period" } ], "description":"The time period over which the service that is described by the document was provided." } } }, "RelatedPerson":{ "type":"object", "required":[ "resourceType", "id", "active", "patient" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "RelatedPerson" ] }, "id":{ "type":"string" }, "active":{ "type":"boolean", "description":"(USCDI) Whether this related person's record is in active use." }, "patient":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) The patient this person is related to." }, "relationship":{ "type":"array", "description":"(USCDI) The nature of the relationship.", "items":{ "$ref":"#/components/schemas/CodeableConcept" } }, "name":{ "type":"array", "description":"(USCDI) A name associated with the person.", "items":{ "$ref":"#/components/schemas/HumanName" } }, "telecom":{ "type":"array", "description":"(USCDI) A contact detail for the person.", "items":{ "$ref":"#/components/schemas/ContactPoint" } }, "address":{ "type":"array", "description":"(USCDI) The address where the related person can be contacted or visited.", "items":{ "$ref":"#/components/schemas/Address" } } } }, "ContactPointRequired":{ "type":"object", "required":[ "system", "value" ], "properties":{ "system":{ "type":"string", "description":"(USCDI) The following values are supported:\n\n" }, "value":{ "type":"string", "description":"(USCDI) The actual contact point details." }, "use":{ "type":"string", "description":"

(USCDI) The purpose of this contact point.

\n

The following values are supported:\n

\n" } } }, "PatientCommunication":{ "type":"object", "required":[ "language" ], "properties":{ "language":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"(USCDI) The language that can be used to communicate with the patient about their health." } } }, "Patient":{ "type":"object", "required":[ "resourceType", "id", "identifier", "name", "gender" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Patient" ] }, "id":{ "type":"string" }, "identifier":{ "type":"array", "description":"(USCDI) An identifier for this patient.", "items":{ "$ref":"#/components/schemas/Identifier" } }, "name":{ "type":"array", "description":"(USCDI) A name associated with the patient.", "items":{ "$ref":"#/components/schemas/HumanName" } }, "telecom":{ "type":"array", "description":"(USCDI) A contact detail for the individual.", "items":{ "$ref":"#/components/schemas/ContactPointRequired" } }, "gender":{ "type":"string", "description":"(USCDI) The following values are supported:\n \n" }, "birthDate":{ "type":"string", "format":"date", "description":"(USCDI) The date of birth for the individual." }, "address":{ "type":"array", "description":"(USCDI) An address for the individual.", "items":{ "$ref":"#/components/schemas/Address" } }, "communication":{ "type":"array", "description":"(USCDI) A language that may be used to communicate with the patient about their health.", "items":{ "$ref":"#/components/schemas/PatientCommunication" } } } }, "Goal":{ "type":"object", "required":[ "resourceType", "id", "lifecycleStatus", "description", "subject" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Goal" ] }, "id":{ "type":"string" }, "lifecycleStatus":{ "type":"string", "description":"(USCDI) The following values are supported:\n \n" }, "description":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"(USCDI) The code or text describing the goal." }, "subject":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) Who this goal is intended for." }, "startDate":{ "type":"string", "format":"date", "description":"(USCDI) When the goal pursuit begins." }, "target":{ "type":"array", "description":"(USCDI) The target outcome for the goal.", "items":{ "$ref":"#/components/schemas/GoalTarget" } } } }, "GoalTarget":{ "type":"object", "properties":{ "dueDate":{ "type":"string", "format":"date", "description":"(USCDI) The target date to reach the goal (on or before this date)." } } }, "CarePlan":{ "type":"object", "required":[ "resourceType", "id", "status", "intent", "category", "subject" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "CarePlan" ] }, "id":{ "type":"string" }, "text":{ "allOf":[ { "$ref":"#/components/schemas/Narrative" } ], "description":"A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human." }, "status":{ "type":"string", "description":"An indicator that the plan is currently being acted upon, represents future intentions, or is now a historical record." }, "intent":{ "type":"string", "description":"The level of authority or intentionality associated with the care plan and where the care plan fits into the workflow chain." }, "category":{ "type":"array", "description":"The type of plan.", "items":{ "$ref":"#/components/schemas/CodeableConcept" } }, "subject":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"Who the care plan is for." } } }, "Extension":{ "type":"object", "properties":{ "url":{ "type":"string", "format":"uri" } } }, "Condition":{ "type":"object", "required":[ "resourceType", "id", "category", "code", "subject" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Condition" ] }, "id":{ "type":"string" }, "identifier":{ "type":"array", "description":"The external IDs for this condition.", "items":{ "$ref":"#/components/schemas/Identifier" } }, "clinicalStatus":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"The clinical status of the condition." }, "verificationStatus":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"The verification status to support the clinical status of the condition." }, "category":{ "type":"array", "description":"

A category assigned to the condition.

\n

In addition to other categories, the following categories are returned:

\n\n", "items":{ "$ref":"#/components/schemas/CodeableConcept" } }, "code":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"(USCDI) The identification of the condition, problem, or diagnosis." }, "subject":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) The individual who has the condition." }, "encounter":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) The encounter during which this condition was created or to which the creation of this record is tightly associated." }, "onsetDateTime":{ "type":"string", "format":"date-time", "description":"(USCDI) The estimated or actual date or date and time." }, "abatementDateTime":{ "type":"string", "format":"date-time", "description":"(USCDI) When the condition is in resolution or remission." }, "recordedDate":{ "type":"string", "format":"date-time", "description":"(USCDI) The date when the record was first recorded." } } }, "Procedure":{ "type":"object", "required":[ "resourceType", "id", "status", "code", "subject" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Procedure" ] }, "id":{ "type":"string" }, "basedOn":{ "type":"array", "description":"(USCDI) A request for this procedure.", "items":{ "$ref":"#/components/schemas/Reference" } }, "status":{ "type":"string", "description":"(USCDI) The following values are supported:\n \n" }, "code":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"(USCDI) The identification of the procedure." }, "subject":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) Who the procedure was performed on." }, "performedDateTime":{ "type":"string", "format":"date-time", "description":"(USCDI) When the procedure was performed." } } }, "MedicationDispense":{ "type":"object", "required":[ "resourceType", "id", "status", "medicationCodeableConcept", "subject" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "MedicationDispense" ] }, "id":{ "type":"string" }, "status":{ "type":"string", "description":"(USCDI) The following values are supported:\n \n" }, "medicationCodeableConcept":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"(USCDI) What medication was supplied." }, "subject":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) Who the dispense is for." }, "performer":{ "type":"array", "description":"(USCDI) The individual who performed the event.", "items":{ "$ref":"#/components/schemas/MedicationDispensePerformer" } }, "authorizingPrescription":{ "type":"array", "description":"(USCDI) The medication order that authorizes the dispense.", "items":{ "$ref":"#/components/schemas/Reference" } }, "type":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"(USCDI) A trial fill, partial fill, emergency fill, and so on." }, "quantity":{ "allOf":[ { "$ref":"#/components/schemas/Quantity" } ], "description":"(USCDI) The amount dispensed." }, "whenHandedOver":{ "type":"string", "format":"date-time", "description":"(USCDI) When the product was given out or mailed." }, "dosageInstruction":{ "type":"array", "description":"(USCDI) How the medication is to be used by the patient or administered by the caregiver.", "items":{ "$ref":"#/components/schemas/Dosage" } } } }, "MedicationDispensePerformer":{ "type":"object", "required":[ "actor" ], "properties":{ "actor":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) The individual who was performing the dispense." } } }, "Dosage":{ "type":"object", "properties":{ "text":{ "type":"string", "description":"(USCDI) The free-text dosage instructions, for example, SIG." }, "timing":{ "type":"object", "description":"(USCDI) When the medication should be administered." }, "doseAndRate":{ "type":"array", "description":"(USCDI) The amount of medication administered.", "items":{ "$ref":"#/components/schemas/DosageDoseAndRate" } } } }, "DosageDoseAndRate":{ "type":"object", "properties":{ "doseQuantity":{ "allOf":[ { "$ref":"#/components/schemas/Quantity" } ], "description":"(USCDI) The amount of medication per dose." } } }, "CareTeam":{ "type":"object", "required":[ "resourceType", "id", "subject", "participant" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "CareTeam" ] }, "id":{ "type":"string" }, "identifier":{ "type":"array", "description":"The business identifiers assigned to this care team by the performer or other systems. The identifiers remain constant as the resource is updated and propagates from server to server.", "items":{ "$ref":"#/components/schemas/Identifier" } }, "status":{ "type":"string", "description":"The current state of the care team." }, "category":{ "type":"array", "description":"The type of team.", "items":{ "$ref":"#/components/schemas/CodeableConcept" } }, "name":{ "type":"string", "description":"A label for human use intended to distinguish like teams." }, "subject":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"The patient or group whose intended care is handled by the team." }, "encounter":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"The encounter during which this care team was created or to which the creation of this record is tightly associated." }, "period":{ "allOf":[ { "$ref":"#/components/schemas/Period" } ], "description":"When the team took effect and ended or is intended to take effect and end." }, "participant":{ "type":"array", "description":"All people and organizations who are expected to be involved in the care team.", "items":{ "$ref":"#/components/schemas/CareTeamParticipant" } }, "managingOrganization":{ "type":"array", "description":"The organization responsible for the care team.", "items":{ "$ref":"#/components/schemas/Reference" } } } }, "CareTeamParticipant":{ "type":"object", "required":[ "role", "member" ], "properties":{ "role":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"The specific responsibility of an individual in the care team, such as a primary care physician, trained social worker counselor, caregiver, and so on." }, "member":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"The specific person or organization who is participating or expected to participate in the care team." }, "onBehalfOf":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"The organization of the practitioner." } } }, "MedicationRequest":{ "type":"object", "required":[ "resourceType", "id", "status", "intent", "medicationCodeableConcept", "subject" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "MedicationRequest" ] }, "id":{ "type":"string" }, "status":{ "type":"string", "description":"(USCDI) The following values are supported:\n \n" }, "intent":{ "type":"string", "description":"(USCDI) The following values are supported:\n \n" }, "category":{ "type":"array", "description":"(USCDI) The type of medication usage.", "items":{ "$ref":"#/components/schemas/CodeableConcept" } }, "reportedBoolean":{ "type":"boolean", "description":"(USCDI) The reported rather than primary record." }, "medicationCodeableConcept":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"(USCDI) The medication to be taken." }, "subject":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) Who or what group the medication request is for." }, "encounter":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) The encounter created as part of the encounter, admission, or stay." }, "authoredOn":{ "type":"string", "format":"date-time", "description":"(USCDI) When the request was initially authored." }, "requester":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) Who or what requested the medication." }, "reasonCode":{ "type":"array", "description":"(USCDI) The reason or indication for ordering or not ordering the medication.", "items":{ "$ref":"#/components/schemas/CodeableConcept" } }, "reasonReference":{ "type":"array", "description":"(USCDI) The U.S. Core condition or observation that supports the prescription.", "items":{ "$ref":"#/components/schemas/Reference" } }, "dosageInstruction":{ "type":"array", "description":"(USCDI) How the medication should be taken.", "items":{ "$ref":"#/components/schemas/Dosage" } }, "dispenseRequest":{ "allOf":[ { "$ref":"#/components/schemas/MedicationRequestDispenseRequest" } ], "description":"(USCDI) The medication supply authorization." }, "substitution":{ "allOf":[ { "$ref":"#/components/schemas/MedicationRequestSubstitution" } ], "description":"Any restrictions on medication substitution." } } }, "MedicationRequestDispenseRequest":{ "type":"object", "properties":{ "numberOfRepeatsAllowed":{ "type":"integer", "description":"(USCDI) The number of refills authorized." }, "quantity":{ "allOf":[ { "$ref":"#/components/schemas/Quantity" } ], "description":"(USCDI) The amount of medication to supply per dispense." } } }, "MedicationRequestSubstitution":{ "type":"object", "required":[ "allowedBoolean" ], "properties":{ "allowedBoolean":{ "type":"boolean", "description":"Whether substitution is allowed." } } }, "Binary":{ "type":"object", "required":[ "resourceType", "id", "contentType" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Binary" ] }, "id":{ "type":"string" }, "meta":{ "type":"object", "properties":{ "lastUpdated":{ "type":"string", "format":"date-time" } } }, "contentType":{ "type":"string", "description":"The type of data in the Binary resource." }, "data":{ "type":"string", "description":"The base64-encoded content of the Binary resource." } } }, "AllergyIntolerance":{ "type":"object", "required":[ "resourceType", "id", "code", "patient" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "AllergyIntolerance" ] }, "id":{ "type":"string" }, "clinicalStatus":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"The clinical status of the allergy or intolerance." }, "verificationStatus":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"The assertion about the certainty associated with the propensity, or potential risk, of a reaction to the identified substance." }, "code":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"The code for an allergy or intolerance statement." }, "patient":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"The patient who has the allergy or intolerance." }, "reaction":{ "type":"array", "description":"The details about each adverse reaction event linked to exposure to the identified substance.", "items":{ "$ref":"#/components/schemas/AllergyIntoleranceReaction" } } } }, "AllergyIntoleranceReaction":{ "type":"object", "required":[ "manifestation" ], "properties":{ "manifestation":{ "type":"array", "description":"The clinical symptoms, signs, or both that are observed or associated with the adverse reaction event.", "items":{ "$ref":"#/components/schemas/CodeableConcept" } } } }, "Immunization":{ "type":"object", "required":[ "resourceType", "id", "status", "vaccineCode", "patient", "occurrenceDateTime" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Immunization" ] }, "id":{ "type":"string" }, "status":{ "type":"string", "description":"(USCDI) The following values are supported:\n \n" }, "statusReason":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"(USCDI) The reason why the immunization was not done." }, "vaccineCode":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"(USCDI) The vaccine product type (bind to vaccines administered [CVX])." }, "patient":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) The patient who was immunized." }, "occurrenceDateTime":{ "type":"string", "format":"date-time", "description":"(USCDI) The vaccine administration date." }, "primarySource":{ "type":"boolean", "description":"(USCDI) The context the data was recorded in." }, "performer":{ "type":"array", "description":"The individual who performed the event.", "items":{ "$ref":"#/components/schemas/ImmunizationPerformer" } } } }, "ImmunizationPerformer":{ "type":"object", "required":[ "actor" ], "properties":{ "actor":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"The individual or organization who performed the event." } } }, "ProvenanceAgent":{ "type":"object", "required":[ "who" ], "properties":{ "type":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"(USCDI) How the agent participated." }, "who":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) Who participated." }, "onBehalfOf":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) Who the agent is representing." } } }, "Provenance":{ "type":"object", "required":[ "resourceType", "id", "target", "recorded", "agent" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Provenance" ] }, "id":{ "type":"string" }, "target":{ "type":"array", "description":"(USCDI) The resource this provenance record supports.", "items":{ "$ref":"#/components/schemas/Reference" } }, "recorded":{ "type":"string", "format":"date-time", "description":"(USCDI) The timestamp when the activity was recorded or updated." }, "agent":{ "type":"array", "description":"(USCDI) The actor involved.", "items":{ "$ref":"#/components/schemas/ProvenanceAgent" } } } }, "Location":{ "type":"object", "required":[ "resourceType", "id", "name" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Location" ] }, "id":{ "type":"string" }, "status":{ "type":"string", "description":"The following statuses are supported:\n \n" }, "name":{ "type":"string", "description":"The name of the location as used by humans." }, "telecom":{ "type":"array", "description":"The contact details of the location.", "items":{ "$ref":"#/components/schemas/ContactPoint" } }, "address":{ "allOf":[ { "$ref":"#/components/schemas/Address" } ], "description":"The physical location." }, "managingOrganization":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"The organization responsible for provisioning and upkeep." } } }, "QuestionnaireResponseAnswer":{ "type":"object", "properties":{ "valueBoolean":{ "type":"boolean", "description":"(USCDI) The single-valued answer to the question." }, "valueDate":{ "type":"string", "format":"date", "description":"(USCDI) The single-valued answer to the question." }, "valueDateTime":{ "type":"string", "format":"date-time", "description":"(USCDI) The single-valued answer to the question." }, "valueTime":{ "type":"string", "description":"(USCDI) The single-valued answer to the question." }, "valueDecimal":{ "type":"number", "description":"(USCDI) The single-valued answer to the question." }, "valueInteger":{ "type":"integer", "description":"(USCDI) The single-valued answer to the question." }, "valueString":{ "type":"string", "description":"(USCDI) The single-valued answer to the question." }, "valueCoding":{ "allOf":[ { "$ref":"#/components/schemas/Coding" } ], "description":"(USCDI) The single-valued answer to the question." }, "valueUri":{ "type":"string", "format":"uri", "description":"(USCDI) The single-valued answer to the question." }, "valueReference":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) The single-valued answer to the question." }, "item":{ "type":"array", "description":"The nested groups and questions.", "items":{ "$ref":"#/components/schemas/QuestionnaireResponseItem" } } } }, "QuestionnaireResponseItem":{ "type":"object", "required":[ "linkId" ], "properties":{ "linkId":{ "type":"string", "description":"(USCDI) The pointer to a specific item from the questionnaire." }, "text":{ "type":"string", "description":"The name for the group or question text." }, "answer":{ "type":"array", "description":"The responses to the question.", "items":{ "$ref":"#/components/schemas/QuestionnaireResponseAnswer" } }, "item":{ "type":"array", "description":"The nested questionnaire response items.", "items":{ "$ref":"#/components/schemas/QuestionnaireResponseItem" } } } }, "QuestionnaireResponse":{ "type":"object", "required":[ "resourceType", "id", "questionnaire", "status", "subject", "authored" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "QuestionnaireResponse" ] }, "id":{ "type":"string" }, "identifier":{ "allOf":[ { "$ref":"#/components/schemas/Identifier" } ], "description":"The unique ID for this set of answers." }, "questionnaire":{ "type":"string", "description":"(USCDI) The form being answered." }, "status":{ "type":"string", "description":"(USCDI) The following values are supported:\n \n" }, "subject":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) The subject of the questions." }, "authored":{ "type":"string", "format":"date-time", "description":"(USCDI) The date when the answers were gathered." }, "author":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) The person who received and recorded the answers." }, "item":{ "type":"array", "description":"(USCDI) The groups and questions.", "items":{ "$ref":"#/components/schemas/QuestionnaireResponseItem" } } } }, "Encounter":{ "type":"object", "required":[ "resourceType", "id", "status", "class", "type", "subject" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Encounter" ] }, "id":{ "type":"string" }, "identifier":{ "type":"array", "description":"(USCDI) The identifiers by which this encounter is known.", "items":{ "$ref":"#/components/schemas/Identifier" } }, "status":{ "type":"string", "description":"(USCDI) The following values are supported:\n \n" }, "class":{ "allOf":[ { "$ref":"#/components/schemas/Coding" } ], "description":"(USCDI) The classification of the patient encounter." }, "type":{ "type":"array", "description":"(USCDI) The specific type of encounter.", "items":{ "$ref":"#/components/schemas/CodeableConcept" } }, "subject":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) The patient or group present at the encounter." }, "participant":{ "type":"array", "description":"(USCDI) The list of participants involved in the encounter.", "items":{ "$ref":"#/components/schemas/EncounterParticipant" } }, "period":{ "allOf":[ { "$ref":"#/components/schemas/Period" } ], "description":"(USCDI) The start and end time of the encounter." }, "reasonCode":{ "type":"array", "description":"(USCDI) The coded reason the encounter takes place.", "items":{ "$ref":"#/components/schemas/CodeableConcept" } }, "reasonReference":{ "type":"array", "description":"(USCDI) The reason the encounter takes place (reference).", "items":{ "$ref":"#/components/schemas/Reference" } }, "hospitalization":{ "allOf":[ { "$ref":"#/components/schemas/EncounterHospitalization" } ], "description":"(USCDI) The details about the admission to a healthcare service." }, "location":{ "type":"array", "description":"(USCDI) The list of locations where the patient has been.", "items":{ "$ref":"#/components/schemas/EncounterLocation" } }, "serviceProvider":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) The organization (facility) responsible for this encounter." } } }, "EncounterParticipant":{ "type":"object", "properties":{ "type":{ "type":"array", "description":"(USCDI) The role of the participant in the encounter.", "items":{ "$ref":"#/components/schemas/CodeableConcept" } }, "period":{ "allOf":[ { "$ref":"#/components/schemas/Period" } ], "description":"(USCDI) The period of time during the encounter when the participant participated." }, "individual":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) The people involved in the encounter other than the patient." } } }, "EncounterHospitalization":{ "type":"object", "properties":{ "dischargeDisposition":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"(USCDI) The category or type of location after discharge." } } }, "EncounterLocation":{ "type":"object", "required":[ "location" ], "properties":{ "location":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) The location where the encounter takes place." } } }, "Media":{ "type":"object", "required":[ "resourceType", "id", "status", "subject", "content" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Media" ] }, "id":{ "type":"string" }, "status":{ "type":"string", "description":"The status of the media." }, "subject":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"The subject of the media. Usually, but not always, the subject is the patient." }, "content":{ "type":"object", "required":[ "contentType" ], "properties":{ "contentType":{ "type":"string", "description":"The type of the data in the attachment, which allows a method to interpret or render the data." }, "data":{ "type":"string", "description":"The base64-encoded content of the media." }, "size":{ "type":"integer", "description":"The number of bytes of data that composes this content (before base64 encoding, if applicable)." } } } } }, "MemberId":{ "type":"object", "required":[ "type" ], "properties":{ "type":{ "type":"object", "required":[ "coding" ], "properties":{ "coding":{ "type":"array", "items":{ "type":"object", "required":[ "system", "code" ], "properties":{ "system":{ "type":"string", "enum":[ "http://terminology.hl7.org/CodeSystem/v2-0203" ] }, "code":{ "type":"string", "enum":[ "MB" ] }, "display":{ "type":"string" } } } }, "text":{ "type":"string" } } }, "system":{ "type":"string", "format":"uri" }, "value":{ "type":"string" } } }, "Coverage":{ "type":"object", "required":[ "resourceType", "id", "status", "beneficiary", "relationship", "payor" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Coverage" ] }, "id":{ "type":"string" }, "identifier":{ "type":"array", "description":"(USCDI) The member ID and other identifiers.", "items":{ "oneOf":[ { "$ref":"#/components/schemas/Identifier" }, { "$ref":"#/components/schemas/MemberId" } ] } }, "status":{ "type":"string", "description":"(USCDI) The following values are supported: \n\n" }, "type":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"(USCDI) The coverage category such as medical or accident." }, "subscriberId":{ "type":"string", "description":"(USCDI) The ID assigned to the subscriber." }, "beneficiary":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) The plan beneficiary." }, "relationship":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"(USCDI) The beneficiary's relationship to the subscriber." }, "period":{ "allOf":[ { "$ref":"#/components/schemas/Period" } ], "description":"(USCDI) The coverage start and end dates." }, "payor":{ "type":"array", "description":"(USCDI) The issuer of the policy.", "items":{ "$ref":"#/components/schemas/Reference" } }, "class":{ "type":"array", "description":"

(USCDI) The additional coverage classifications.

\n\n", "items":{ "$ref":"#/components/schemas/CoverageClass" } } } }, "CoverageClass":{ "type":"object", "required":[ "type", "value" ], "properties":{ "type":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"The type of class such as group or plan." }, "value":{ "type":"string", "description":"The value associated with the type." }, "name":{ "type":"string", "description":"A human-readable description of the type and value." } } }, "Attachment":{ "type":"object", "properties":{ "contentType":{ "type":"string" }, "data":{ "type":"string" }, "url":{ "type":"string", "format":"uri" } } }, "DiagnosticReport":{ "type":"object", "required":[ "resourceType", "id", "status", "category", "code", "subject" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "DiagnosticReport" ] }, "id":{ "type":"string" }, "status":{ "type":"string", "description":"(USCDI) The status of the diagnostic report." }, "category":{ "type":"array", "description":"

(USCDI) The service category.

\n\n", "items":{ "$ref":"#/components/schemas/CodeableConcept" } }, "code":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"(USCDI) The test, panel, report, or note that was ordered." }, "subject":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) The subject of the report. Usually, but not always, the subject is the patient." }, "encounter":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) The healthcare event that this diagnostic report is about." }, "effectiveDateTime":{ "type":"string", "format":"date-time", "description":"(USCDI) The diagnostically relevant time that the report is related to." }, "effectivePeriod":{ "allOf":[ { "$ref":"#/components/schemas/Period" } ], "description":"(USCDI) The diagnostically relevant time period that the report is related to." }, "issued":{ "type":"string", "format":"date-time", "description":"(USCDI) The date and time when this version of the report was made available." }, "performer":{ "type":"array", "description":"(USCDI) The diagnostic service that is responsible for issuing the report.", "items":{ "$ref":"#/components/schemas/Reference" } }, "result":{ "type":"array", "description":"(USCDI) The observations that are part of this diagnostic report.", "items":{ "$ref":"#/components/schemas/Reference" } }, "media":{ "type":"array", "description":"(USCDI) The key images that are associated with this report.", "items":{ "$ref":"#/components/schemas/DiagnosticReportMedia" } }, "conclusion":{ "type":"string", "description":"The clinical conclusion (interpretation) of the test results." }, "presentedForm":{ "type":"array", "description":"(USCDI) The rich-text representation of the entire result as issued by the diagnostic service.", "items":{ "$ref":"#/components/schemas/Attachment" } } } }, "DiagnosticReportMedia":{ "type":"object", "required":[ "link" ], "properties":{ "link":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) A reference to the image source." } } }, "SpecimenCollection":{ "type":"object", "properties":{ "collector":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"Who collected the specimen." }, "collectedDateTime":{ "type":"string", "format":"date-time", "description":"The collection time." }, "collectedPeriod":{ "type":"object", "properties":{ "start":{ "type":"string", "format":"date-time" }, "end":{ "type":"string", "format":"date-time" } }, "description":"The collection time." } } }, "SpecimenContainer":{ "type":"object", "properties":{ "identifier":{ "type":"array", "description":"The ID for the container.", "items":{ "$ref":"#/components/schemas/Identifier" } } } }, "Specimen":{ "type":"object", "required":[ "resourceType", "id", "type" ], "properties":{ "resourceType":{ "type":"string", "enum":[ "Specimen" ] }, "id":{ "type":"string" }, "identifier":{ "type":"array", "description":"The external identifier.", "items":{ "$ref":"#/components/schemas/Identifier" } }, "accessionIdentifier":{ "allOf":[ { "$ref":"#/components/schemas/Identifier" } ], "description":"The identifier assigned by the laboratory." }, "status":{ "type":"string", "description":"The following values are supported:\n \n" }, "type":{ "allOf":[ { "$ref":"#/components/schemas/CodeableConcept" } ], "description":"(USCDI) The type of material that forms the specimen." }, "subject":{ "allOf":[ { "$ref":"#/components/schemas/Reference" } ], "description":"(USCDI) The patient where the specimen came from." }, "receivedTime":{ "type":"string", "format":"date-time", "description":"The time when the specimen was received for processing." }, "collection":{ "allOf":[ { "$ref":"#/components/schemas/SpecimenCollection" } ], "description":"The collection details." }, "container":{ "type":"array", "description":"The direct container of the specimen.", "items":{ "$ref":"#/components/schemas/SpecimenContainer" } }, "condition":{ "type":"array", "description":"The state of the specimen.", "items":{ "$ref":"#/components/schemas/CodeableConcept" } } } } } }, "tags":[ { "name":"AllergyIntolerance", "description":"The operations from the AllergyIntolerance category." }, { "name":"Binary", "description":"The operations from the Binary category." }, { "name":"CarePlan", "description":"The operations from the CarePlan category." }, { "name":"CareTeam", "description":"The operations from the CareTeam category." }, { "name":"Condition", "description":"The operations from the Condition category." }, { "name":"Coverage", "description":"The operations from the Coverage category." }, { "name":"Device", "description":"The operations from the Device category." }, { "name":"DiagnosticReport", "description":"The operations from the DiagnosticReport category." }, { "name":"DocumentReference", "description":"The operations from the DocumentReference category." }, { "name":"Encounter", "description":"The operations from the Encounter category." }, { "name":"Goal", "description":"The operations from the Goal category." }, { "name":"Immunization", "description":"The operations from the Immunization category." }, { "name":"Location", "description":"The operations from the Location category." }, { "name":"Media", "description":"The operations from the Media category." }, { "name":"MedicationDispense", "description":"The operations from the MedicationDispense category." }, { "name":"MedicationRequest", "description":"The operations from the MedicationRequest category." }, { "name":"Observation", "description":"The operations from the Observation category." }, { "name":"Organization", "description":"The operations from the Organization category." }, { "name":"Patient", "description":"The operations from the Patient category." }, { "name":"Practitioner", "description":"The operations from the Practitioner category." }, { "name":"Procedure", "description":"The operations from the Procedure category." }, { "name":"Provenance", "description":"The operations from the Provenance category." }, { "name":"QuestionnaireResponse", "description":"The operations from the QuestionnaireResponse category." }, { "name":"RelatedPerson", "description":"The operations from the RelatedPerson category." }, { "name":"ServiceRequest", "description":"The operations from the ServiceRequest category." }, { "name":"Specimen", "description":"The operations from the Specimen category." } ] }