Top Banner
OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26
43

OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

Jul 06, 2018

Download

Documents

ledien
Welcome message from author
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
Page 1: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon

Version draft

2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide

Copyright Notice

Copyright copy 2016 eHealth Ontario

All rights reserved

No part of this document may be reproduced in any form including photocopying or transmission electronically to

any computer without prior written consent of eHealth Ontario The information contained in this document is

proprietary to eHealth Ontario and may not be used or disclosed except as expressly authorized in writing by eHealth

Ontario

Trademarks

Other product names mentioned in this document may be trademarks or registered trademarks of their respective

companies and are hereby acknowledged

Document Control

The electronic version of this document is recognized as the only valid version

Document Location TBD

Document Prime

Enquiries relating to this

document should be referred to the

Document Prime

eHealth Ontario OLIS FHIR Interface Implementation Guide

Significant Contributors

Name Title Organization Contact

Natalya Pogrebetsky Sr Standards Analyst eHealth Ontario

Sanjaai Udukumbura

Solutions Architect eHealth Ontario

Approval History Approver(s) Title

OLIS FHIR IG Revision History Version No

Date Summary of Change Changed By

01 26 April 2017 Initial version Natalya Pogrebetsky

eHealth Ontario OLIS FHIR Interface Implementation Guide Page i

Table of Contents 1 Introduction 3

Summary and Scope 3 11

Intended Audience 3 12

Background 3 13

Reference Materials 4 14

2 How to Implement HL7 FHIR 5 Content Types and Encodings 5 21

Summary of all FHIR Request Interactions 5 Special Case Missing data 5 Naming Convention 6

3 Supported Operations 8 Search Laboratory Report 8 31

311 Search Parameter Types 8 312 Prefixes 8 313 Supported Search Parameters 9 314 Search Example 9

4 FHIR Resources Definitions 10 General Overview 10 41

411 Supported Attributes 10 412 Format 10

Infrastructure Resources 10 42

421 Resource - Base Resource Definitions 10 422 DomainResource Resource 10 423 Bundle Resource 11 424 OperationOutcome Resource 12 425 Using Operation Outcome Resources 12 426 Reporting Errors in the HTTP Headers 13 427 OperationOutcome Example - Search 13

FHIR Resources 14 43

431 Diagnostic Report Profile 15 432 Procedure Request Profile 16 433 Observation Profile 20 434 Specimen Profile 22 435 Patient Profile 24 436 Practitioner Profile (Ordering Practitioner) 26 437 Practitioner Profile (CC List Practitioner) 27 438 Practitioner Profile (Attending Practitioner) 29 439 Practitioner Profile (Admitting Practitioner) 30 4310 Organization Profile (Ordering Facility) 31 4311 Organization Profile (Performing Laboratory) 31 4312 Organization Profile (Reporting Laboratory) 32 4313 Organization Profile (Specimen Collector Center) 33

eHealth Ontario OLIS FHIR Interface Implementation Guide Page ii

4314 Organization Profile (Test Request Placer) 33 4315 Organization Profile (Destination Laboratory) 34 4316 Encounter Profile 34

Data Type Notes 35 44

441 Date 35 442 DateTime 35 443 Time 36 444 URI 36

Appendix A JWT Autorisation header 37 HTTP Response Codes 37 IANA Defined HTTP Status Codes 37

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 3

1 Introduction

Summary and Scope 11

The purpose of this document is to capture solution design for Ontario Laboratories Information System (OLIS) It establishes a common understanding amongst

the stakeholder groups of the solution design needed development and implementation of the OLIS Solution The scope of this document will evolve over the

lifecycle of the project

Intended Audience 12

The intended audiences of this document are business and technical implementers who are interested in retrieving laboratory reports from OLIS The readers are

expected to have an understanding of the business and technical requirements for querying and receiving laboratory report information from the Ontario

Laboratories Information System

Background 13

OLIS is a single provincial system that allows all laboratory information on human beings in Ontario to be exchanged electronically between practitioners and

laboratory service providers and provides the Ministry of Health and Long-Term Care (MOHLTC) with program management information OLIS facilitates the

exchange of laboratory information on human beings in Ontario amongst LIS HIS EMR and other point of service systems (POS) but it is not a LIS system in its

own right and is not intended to replace existing LIS systems OLIS has an existing HL7 v2 interface used by labs to submit results and Inquiry interface used by

clinical point of service (POS) systems

Primary intension of the OLIS FHIR interface is to provide an interface that can be used by patients to access their information in OLIS (consumer interface)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 4

Reference Materials 14

Table 1 Reference Materials

Document Name Location

HL7 FHIR STU3 httphl7orgfhir

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 5

2 How to Implement HL7 FHIR

Content Types and Encodings 21

The formal MIME-type for FHIR resources is applicationjson+fhir or applicationxml+fhir The correct mime type SHALL be used by clients and servers

JSON (preferred) applicationjson+fhir

XML (optional) applicationxml+fhir

FHIR uses UTF-8 for all request and response bodies Since the HTTP specification defines a default character encoding of ISO-8859-1 requests and responses

SHALL explicitly set the character encoding to UTF-8 using the charset parameter of the MIME-type in the Content-Type header Requests MAY also specify

this charset parameter in the Accept header andor use the Accept-Charset header

Summary of all FHIR Request Interactions

The table below shows the allowed transactions on FHIR resources and their corresponding HTTP operations

Table 2 OLIS FHIR HTTP Operations

Resource Transaction HTTP Verb

DiagnosticReport Search GET

DiagnosticReport Read GET

Special Case Missing data

In some cases implementers may find that they do not have appropriate data for an element with minimum cardinality = 1 In this case the element must be

present but unless the resource or a profile on it has made the actual value of the primitive data type mandatory it is possible to provide an extension that explains

why the primitive value is not present

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 6

XML

lturigt

ltextension url=httphl7orgfhirStructureDefinitiondata-absent-reasongt

ltvalueCode=unknowngt

ltextensiongt

lturigt

JSON

_uri

extension [

url httphl7orgfhirStructureDefinitiondata-absent-reason

valueCode unknown

]

In this example instead of a value a data missing code is provided (httpswwwhl7orgfhirextension-data-absent-reasonhtml) Note that it is not required that

this particular extension is used This extension is not a modifier extension because the primitive data type has no value

It is not valid to create a fictional piece of data for the primitive value and then to add an extension indicating that the data has been constructed to meet the data

rules This would be both a bad idea and also a modifier extension which is not allowed on data types

Naming Convention

The base URL for OLIS FHIR interface will be referred to as ldquo[base]rdquo in the sections and examples below Please note that base URL might change over time

The base for Naming System (namespace of identifiers and code system of local terminologies) is httpsehealthontariocaAPIFHIRNamingSystem For

globalshareable identifiers (eg Ontario health care number Ontario Physician License etc) this might be replaced with httphl7orgfhirNamingSystemca-

on-license-physician in the future when HL7 FHIR Naming System registry is available The base for global identifier namespaces will be referred to as [id-

system-global-base] in the sections and examples below The base for local identifier namespaces (eg placer group number order number etc) will be referred

to as ldquo[id-system-local-base]rdquo in the sections and examples below The base for local code systems (eg test request code) will be referred to as ldquo[code-system-local-

base]rdquo in the sections and examples below

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 7

Variable Value

[base] httpswsgatewayprodehealthontariocaAPIFHIRLaboratoryv1Diagnostic

Report

[base-structure] httpsehealthontariocaAPIFHIRStructureDefinition

[id-system-global-base] httpsehealthontariocaAPIFHIRNamingSystem

[id-system-local-base] httpsehealthontariocaAPIFHIRNamingSystem

[code-system-local-base] httpsehealthontariocaAPIFHIRNamingSystem

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 8

3 Supported Operations

Search Laboratory Report 31

This interaction searches a set of resources based on some filter criteria The interaction can be performed by several different HTTP commands

GET [base][type][parameters]amp_format=[mime-type]

This searches all resources of a particular type using the criteria represented in the parameters

All these search interactions take a series of parameters that are a series of name=value pairs encoded in the URL (See W3C HTML forms)

If the search fails (cannot be executed not that there is no matches) the return value is a status code 4xx or 5xx with an OperationOutcome If the search succeeds

the return content is a Bundle with type = searchset containing the results of the search as a list of resources in a defined order The result list can be long so server

will use paging (adapted from RFC 5005 (Feed Paging and Archiving) for breaking the list into pages if appropriate (see Paging section below) The server may also

return an OperationOutcome resource with additional information about the search

311 Search Parameter Types

Each search parameter is defined by a type that specifies how the search parameter behaves These are the defined parameter types

number Search parameter SHALL be a number (a whole number or a decimal)

date Search parameter is on a datetime The date format is the standard XML format

string Search parameter is a simple string like a name part Search is case-insensitive and accent-insensitive May match just the start of a string String

parameters may contain spaces

token Search parameter on a coded element or identifier May be used to search through the text displayname code and codecodesystem (for codes) and label

system and key (for identifier) Its value is either a string or a pair of namespace and value separated by a | depending on the modifier used

312 Prefixes

For the ordered parameter types of number date and quantity a prefix to the parameter value may be used to control the nature of the matching To avoid URL

escaping and visual confusion the following prefixes are used

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 9

eq the value for the parameter in the resource is equal to the provided value the range of the search value fully contains the range of the target value

gt the value for the parameter in the resource is greater than the provided value the range above the search value intersects (ie overlaps) with the

range of the target value

lt the value for the parameter in the resource is less than the provided value the range below the search value intersects (ie overlaps) with the

range of the target value

ge the value for the parameter in the resource is greater or equal to the provided value the range above the search value intersects (ie overlaps) with the

range of the target value or the range of the search value fully contains

the range of the target value

le the value for the parameter in the resource is less or equal to the provided value the range below the search value intersects (ie overlaps) with the

range of the target value or the range of the search value fully contains

the range of the target value

If no prefix is present the prefix eq is assumed

313 Supported Search Parameters

GET DiagnosticReport (query by Patient ID) o Patient ID parameter patientpatientidentifier

Only Ontario health card number is allowed as an ID parameter in the current release Example patientpatientidentifier=[id-system-global-base]ca-on-patient-hcn|12345678

o Patient Gender parameter gender patientgender Example patientgender=male

o Patient Date of Birth parameter patientbirthdate Example patientbirthdate=19291129

o Dates parameter issuedstart Example issuedstart=ge20160102

314 Search Example

GET [base] DiagnosticReportspatientpatientidentifier=[id-system-global-base]ca-on-patient-hcn| 1008624486amp patientgender=maleamppatientbirthdate=19291129ampissuedstart=ge20160102

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 10

4 FHIR Resources Definitions

General Overview 41

411 Supported Attributes

Only attributes described in the subsections below will be supported

412 Format

OLIS will support JSON and XML formats JSON is the preferred format

Infrastructure Resources 42

421 Resource - Base Resource Definitions

httpwwwhl7orgFHIRresourcehtml Name Card Type ValueVocab Description Comments id 01 id Unique ID set by FHIR server Logical id of this artifact meta 01 Meta Only ldquolastUpdatedrdquo element to be populated

by FHIR server Metadata about the resource

lastUpdated 01 instant This value changes each time the content of the resource changes

language 01 code Used only for Bundle and fixed to ldquoenrdquo in the current release

Language of the resource content

422 DomainResource Resource

httpwwwhl7orgFHIRdomainresourcehtml

A resource with narrative extensions and contained resources

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 11

If a resource is contained in another resource it SHALL NOT have a metaversionId or a metalastUpdated

If the resource is contained in another resource it SHALL be referred to from elsewhere in the resource

If the resource is contained in another resource it SHALL NOT contain nested Resources

If the resource is contained in another resource it SHALL NOT contain any narrative

Most resources are derived from Domain Resources - so they also can contain text contained resources extensions and data elements specific to the particular

domain of the resource

Name Card Type ValueVocab Description Comments text 01 Narrative Text summary of the resource for human

interpretation Not used in the current release

contained 0 Resource Contained inline Resources extension 0 Extension Additional Content defined by

implementations

modifierExtension

0 Extension Extensions that cannot be ignored

423 Bundle Resource

Based on httpwwwhl7orgFHIRbundlehtml

A special type of resource for collections of resources

A set of search results (type = searchset) consists of a series of zero or more entries Each entry element will contain a resource

Bundletotal may be used to return the total number of resources that match the search and that may be returned by following the next link

Name Card Type ValueVocab Description Comments type 11 code Fixed to ldquosearchsetrdquo Type of bundle total 01 unsignedI

nt The total number of matches

link 0 BackboneElement

Links related to this Bundle Optional element might be returned by a server

relation 11 string ldquoselfrdquo for the link to the this Bundle ldquonextrdquo for the link to the next page

ValueSet httpwwwianaorgassignmentslink-relationslink-relationsxhtml

url 11 uri Reference details for the link entry 0 Backbone

Element Entry in the bundle - will have a resource

or information

fullUrl 01 uri The fullUrl element must be present when a resource is present and not present otherwise

Absolute URL for resource (server address or UUIDOID)

resource 01 Resource A resource in the bundle

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 12

424 OperationOutcome Resource

Based on httphl7orgfhiroperationoutcomehtml

Operation Outcomes are sets of error warning and information messages that provide detailed information about the outcome of some attempted system

operation They are provided as a direct system response or component of one where they provide information about the outcome of the operation

OperationOutcomes are used in the following circumstances

When an RESTful operation fails

As the response on a validation operation to provide information about the outcomes

As part of a message response usually when the message has not been processed correctly

This resource is not used for reporting clinical or workflow issues associated with a proposed or ongoing action The resource is not designed to be persisted or

referenced from other parts of the workflow

Name Card

Type ValueVocab Description Comments

issue 1 BackboneElement

A single issue associated with the action

severity 11 code ValueSethttphl7orgfhirvalueset-issue-severityhtml

fatal | error | warning | information

code 11 ValueSethttphl7orgfhirvalueset-issue-typehtml

Error or warning code

details 01 CodeableConcept

ValueSet httphl7orgfhirvalueset-operation-outcomehtml

Additional details about the error

diagnostics 01 string Additional diagnostic information about the issue

location 0 string XPath of element(s) related to issue

425 Using Operation Outcome Resources

On the RESTful interface operation outcome resources are only relevant when a level of computable detail is required that is more granular than that provided by

the HTTP response codes This granularity could include

more detail about the location of an issue

the ability to identify multiple distinct issues

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 13

provision of finer error codes that connect to known business failure states

426 Reporting Errors in the HTTP Headers

Server may also need to report errors in the HTTP headers - especially query parameters when processing searches Errors are reported using a case sensitive

location that has two parts a fixed http and the header or query parameter name separated by a Some examples

Location Description

httpnameexact A reference to the search parameter name with the modifier exact

httpAuthorization A reference to the Authorization header - perhaps to indicate that it is missing and some form of authentication is required

427 OperationOutcome Example - Search

resourceType OperationOutcome

id OperationOutcome1234

issue [

severity fatal

code code-invalid

details

text The name parameter has the modifier exact which is not supported by this server

location [

httpnameexact

]

]

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 14

FHIR Resources 43

DiagnosticReport

PractitionerOrdering Practitioner

Extension ResultCopiestoPractitioners

PatientDiagnosticReportSubject

Organization

PerformingLab

DiagnosticReport

OrganizationReportingLab

ObservationDiagnosticReportResult

SpecimenDiagnosticReportSpecimen

ProcedureRequestDiagnosticReportProcedureRequest

PractitionerAttendingAdmitting

OrganizationExtension

SpecimenCollectorCenter

OrganizationExtension

DestinationLabOrderPlacer

Encounter

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 15

431 Diagnostic Report Profile

ca-on-Diagnostic-DiagnosticReport based on Diagnostic Report profile httphl7orgfhirdiagnosticreporthtml

Name Card Type ValueVocab Description Comments identifier 11 Identifier Identifier assigned by the sending

organization - this is an identifier assigned outside FHIR

This field contains an identifier for the entire order The Placer Group Number is conceptually equivalent to a requisition number assigned to all test requests in an order by an organization (ORC4)

system 11 Uri

The source of the lab reports (ORC43)

value 11 string The unique identifier of the lab report record (ORC41)

status 11 code Value set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

code CodeableConcept

coding 11 coding Fixed code ldquo11502-2rdquo Code defined by a LOINC text 11 string Fixed value ldquoLaboratory Reportrdquo Plain text representation of the concept

Subject (patient)

11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

issued 01 instant dateTime when test request has been issued An instant in time - known at least to the second and always includes a time zone This field will be populated by system (OBR22)

performer 01 Reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

The individual responsible for reporting test result Can be reporting laboratory or reporting practitioner

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 16

Name Card Type ValueVocab Description Comments reference 11 string A reference to a location at which the

other resource is found

request 1 Reference Contained ca-on-Diagnostic-ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

specimen 01 Reference Contained ca-on-Diagnostic-Specimen (Specimen) resource

Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

Result 1 Reference Contained ca-on-Diagnostic-Observation (Observation) resource

List of all the observation associated with the test request (OBX)

reference 11 string A reference to a location at which the other resource is found

codedDiagnosi

s

01 CodeableCon

cept

Value Set ICD10 Diagnosis information

coding 11 coding A reference to a location at which the other resource is found

text 11 string A reference to a location at which the other resource is found

432 Procedure Request Profile

ca-on-Diagnostic-ProcedureRequest profile based on httphl7orgfhirprocedurerequesthtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier assigned by the ordering facility - this is an identifier assigned outside FHIR Must contain a value assigned by the order-placing organization that uniquely identifies this test request among all test requests in OLIS (OBR2)

system 11 Uri The source of test request on the lab report (OBR23)

value 11 string The unique identifier of the test request record (OBR21)

This represents the test request number from the LIS or HIS systems

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 17

Name Card Type ValueVocab Description Comments

status 11 code Value Set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

intent 11 code Value set httphl7orgfhirValueSetrequest-intent

proposal | plan | original-order | order| reflex-order (OBR11)

If OBR11 contains lsquoGrsquo populate lsquoreflex-testrsquo value otherwise fix the value to lsquoOrderrsquo

priority 11 code Value set httphl7orgfhirValueSetrequest-priority

routine | urgent | asap | stat

RequestPriority (Required) (OBR276)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Context (encounter)

11 Reference Contained ca-on-Diagnostic-Encounter (Encounter) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

occuranceDateTime

11 dateTime When testing should occur (OBR274) For routine orders populate this field with the current date

For timing-critical orders populate this field with the date and time that the specimen is to be obtained

For future-dated orders populate this field with the scheduled future date (and time if applicable) when the laboratory test is to occur

extension

01 DateTime of Transaction (ORC9) Populate this field with the

date and time of the event

that initiated the current

transaction

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 18

url 11 httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-dateTime-transaction

valueDateTime 11 dateTime

requester 11 BackboneElement

agent 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the personorganization making request to perform the test (ordering practitionerorganization OBR16)

IF Ordering Facility exists in the message (ORC21) Scenario 1 requester (OBR16) is organization populate ORC21 with the same organization information that in OBR16 field Scenario 2 requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

onBehalfOf 01 reference Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the organization agent is acting for ordering facility

Should be mapped to ordering facility (ORC21 and ORC22) where requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension CCrsquod list practitioner (OBR28) url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-cc-practitioner-list

valueReference (Practitioner)

110 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Practitioners named on an order (attending admitting ccrsquod)

reference 11 string A reference to a location at which the

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 19

other resource is found extension 01 Extension Test Request Placer ZBR2

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-test-request-placer

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Original Test Request Placer

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension Destination Laboratory ZBR8 url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-destination-laboratory

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Destination Laboratory

reference 11 string A reference to a location at which the other resource is found

note 05 Annotation comments authorString 11 string ZNT segment Indicate the organization

(or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

extension 11 Extension Source of Comment (NTE2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-source-comment

valueString

11 string

extension 11 Extension Set ID (NTE1)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 20

set-id

valueString

11 string

433 Observation Profile

ca-on-Diagnostic-Observation profile based on httphl7orgfhirobservationhtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Unique ID for the particular observation (OBR3)

system 11 uri The namespace for the identifier (OBR32) value 11 string The value that is unique (OBR31)

status 11 code Value set Observation result status (OBX11) code CodeableCo

ncept Value set LOINCSNOMED CT

Test result code (OBX3)

coding 11 coding Code defined by a terminology system (OBX31)

text 11 string Plain text representation of the concept (OBX32)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

effective 01 Clinically relevant time for observation

effectiveDateTime

01 dateTime DateTime of observation OBX141 Use this field for ancillary order only

This field must be empty when a laboratory reports a test result

issued 11 instant Indicate the date and time that the Test Result was released by the Reporting Laboratory (ZBX1)

performer (organization)

11 Reference Contained ca-on-Deagnostic-Organization (Organization) Resource or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

The individual responsible for performing the test Can be laboratory or practitioner

reference 11 string A reference to a location at which the other resource is found

value 11 Actual result

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 21

Name Card Type ValueVocab Description Comments

valueQuantity 11 Quantity (OBX2)-Only numeric test value value 11 decimal Numeric value of the test result (OBX5) unit 01 string When observation Value is a scalar value this

field describes the units of measure (OBX61)

interpretation 01 CodebaleConcept

Observation Interpretation Codes(OBX8)

coding 01 Coding Value set method 01 CodebaleCo

ncept How the observation has been done (OBX17)

text 11 string Plain text (OBX172) specimen 01 Reference Contained ca-on-Diagnostic-

Specimen (Specimen) resource Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

referenceRange 01 BackboneElement

Normal range of value associated with observation result (OBX7)

text 11 string Text based reference range in an observation

extension 01 Extension Nature of Abnormal Test (OBX10)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-nature-abnormal-test

valuecoding

11 coding Value set

extension 01 Extension Observation sub-id (OBX4)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation sort key (ZBX2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation comment (NTE-ZNT)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 22

url 11 uri httpehealthontariocaAPIfhir

StructureDefinitiondiagnosticReport-ext-observation-comment

valueAnnotation

11 annotation

authorString

11 string ZNT segment Indicate the organization (or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

434 Specimen Profile

ca-on-Diagnostic-Specimen profile based on httphl7orgfhirspecimenhtml

Name Card Type ValueVocab Description Comments

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

receivedTime 11 dateTime The time when specimen was received for processing

OBR14

request 1 Reference Contained ca-on-Diagnostic- ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

extension 11 Extension Organization that collected the specimen

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-specimen-collector-center

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Specimen Collector Center (ZBR3)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 23

Name Card Type ValueVocab Description Comments

Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

reference 11 string A reference to a location at which the other resource is found

reference 11 string A reference to a location at which the other resource is found

collected 01 Specimen collection time CollectedPeriod 11 Period

start 01 dateTime Starting specimen time OBR7 end 01 dateTime End specimen time OBR8

type 01 CodeableConcept

Kind of material that forms the specimen (Specimen Type)

OBR15

coding 01 coding Value Set from OLIS Code define by the terminology system

OBR1511

text 01 string Plain text representation of the concept

OBR1512

bodySite 01 CodeableConcept

Value Set Anatomical collection site OBR155

container 01 BackboneElement

Direct container of specimen

identifier 02 identifier Id for container OBR18 andor OBR20 Referring Lab User Specimen Identifier and Performing Lab User Specimen Identifier on Refereed ndashout orders

specimenQuantity

01 SimpleQuantity

Quantity of specimen within container

OBR37

note 01 Annotation Collectors comments text 11 string Collectors comments OBR39

extension 01 Extension Collection volume (OBR9)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-collection-volume

valueQuantity

11 Quantity

value 11 decimal Numeric value of the collection OBR91

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 24

volume unit 01 string Units of measure OBR921

435 Patient Profile

ca-on-Diagnostic-Patient profile based on httphl7orgfhirpatienthtml

Name

Card Type ValueVocab Description Comment

identifier

1 Identifier An identifier for this patient

system 11 uri [id-system-global-base]ca-on-patient-hcn

Patient Identifier Assigning Authority Namespace in which set of possible id values is unique (PID391 PID392 PID393)

Value 11 string Patient Identifier Number The portion of the identifier typically displayed to the user and which is unique within the context of the system (PID31)

extension 01 Health Card Version code (PID311) this is an extension patient identifier

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionext-identifier-hcn-version-code

valueString 11 string name

01 HumanName

use 11 code Value set httphl7orgfhirValueSetname-use

Purpose of this name Name type code PID57

Fix to the official for all cases except for anonymous For anonymous code should be lsquoanonymousrsquo

family 11 string Patient Last Name (PID51) given 02 string Patient First Name(PID52) extension 01 patient middle name (PID53)

this is an extension of given name

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode 11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name (PID55)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 25

Name

Card Type ValueVocab Description Comment

suffix 02 String Parts that come after the name (PID54)

extension 01 Patient degree designation This is an extension of suffix

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoACrdquo Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

telecom 03 Demographics Patient table Telephone Number system 01 code httphl7orgfhir

ValueSetcontact-point-system

Telecommunications form for contact point (Phone fax email pager url sms other) PID133 or PID143

Value 11 string The actual contact point details PID134-PID138 Or PID144-PID148

use 01 code httphl7orgfhirValueSetcontact-point-use

Use of contact point (Home work temp old mobile) PID132 or PID142

gender 11 code ldquomalerdquo ldquofemalerdquo ldquootherrdquo ldquounknownrdquo (httphl7orgfhirValueSetadministrative-gender)

The gender of a person used for administrative purposes (PID8)

birthDate 11 date The date of birth for the individual (PID7) Deceased[x]

01 boolean|dateTime

Indicates if the individual is deceased or not The value must be one of the choices specified below but not both System creating instance of this resource must decide which type to use at run time (PID30)

deceasedBoolean

boolean true|false

deceasedDateTime

dateTime Deceased datetime if known (PID29)

address 12 Address Demographics Patient table Address for the individual (PID11)

use 11 code ValueSet httphl7orgfhir

Address Type The use of an address

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 26

Name

Card Type ValueVocab Description Comment

ValueSetaddress-use

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

line 11 string Street lines (PID111) city 11 string Name of city town etc (PID113) state 01 string Province or territory (PID114) postalCode 01 string Postal code for area (PID115) country 11 string Country (can be ISO 3166 3 letter code) (PID116)

436 Practitioner Profile (Ordering Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent Ordering Practitioner information

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR1622

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR161

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR162 given 12 string Practitioner First Name OBR163

extension

01 Practitioner middle name this is an extension of given name

OBR164

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 2: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide

Copyright Notice

Copyright copy 2016 eHealth Ontario

All rights reserved

No part of this document may be reproduced in any form including photocopying or transmission electronically to

any computer without prior written consent of eHealth Ontario The information contained in this document is

proprietary to eHealth Ontario and may not be used or disclosed except as expressly authorized in writing by eHealth

Ontario

Trademarks

Other product names mentioned in this document may be trademarks or registered trademarks of their respective

companies and are hereby acknowledged

Document Control

The electronic version of this document is recognized as the only valid version

Document Location TBD

Document Prime

Enquiries relating to this

document should be referred to the

Document Prime

eHealth Ontario OLIS FHIR Interface Implementation Guide

Significant Contributors

Name Title Organization Contact

Natalya Pogrebetsky Sr Standards Analyst eHealth Ontario

Sanjaai Udukumbura

Solutions Architect eHealth Ontario

Approval History Approver(s) Title

OLIS FHIR IG Revision History Version No

Date Summary of Change Changed By

01 26 April 2017 Initial version Natalya Pogrebetsky

eHealth Ontario OLIS FHIR Interface Implementation Guide Page i

Table of Contents 1 Introduction 3

Summary and Scope 3 11

Intended Audience 3 12

Background 3 13

Reference Materials 4 14

2 How to Implement HL7 FHIR 5 Content Types and Encodings 5 21

Summary of all FHIR Request Interactions 5 Special Case Missing data 5 Naming Convention 6

3 Supported Operations 8 Search Laboratory Report 8 31

311 Search Parameter Types 8 312 Prefixes 8 313 Supported Search Parameters 9 314 Search Example 9

4 FHIR Resources Definitions 10 General Overview 10 41

411 Supported Attributes 10 412 Format 10

Infrastructure Resources 10 42

421 Resource - Base Resource Definitions 10 422 DomainResource Resource 10 423 Bundle Resource 11 424 OperationOutcome Resource 12 425 Using Operation Outcome Resources 12 426 Reporting Errors in the HTTP Headers 13 427 OperationOutcome Example - Search 13

FHIR Resources 14 43

431 Diagnostic Report Profile 15 432 Procedure Request Profile 16 433 Observation Profile 20 434 Specimen Profile 22 435 Patient Profile 24 436 Practitioner Profile (Ordering Practitioner) 26 437 Practitioner Profile (CC List Practitioner) 27 438 Practitioner Profile (Attending Practitioner) 29 439 Practitioner Profile (Admitting Practitioner) 30 4310 Organization Profile (Ordering Facility) 31 4311 Organization Profile (Performing Laboratory) 31 4312 Organization Profile (Reporting Laboratory) 32 4313 Organization Profile (Specimen Collector Center) 33

eHealth Ontario OLIS FHIR Interface Implementation Guide Page ii

4314 Organization Profile (Test Request Placer) 33 4315 Organization Profile (Destination Laboratory) 34 4316 Encounter Profile 34

Data Type Notes 35 44

441 Date 35 442 DateTime 35 443 Time 36 444 URI 36

Appendix A JWT Autorisation header 37 HTTP Response Codes 37 IANA Defined HTTP Status Codes 37

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 3

1 Introduction

Summary and Scope 11

The purpose of this document is to capture solution design for Ontario Laboratories Information System (OLIS) It establishes a common understanding amongst

the stakeholder groups of the solution design needed development and implementation of the OLIS Solution The scope of this document will evolve over the

lifecycle of the project

Intended Audience 12

The intended audiences of this document are business and technical implementers who are interested in retrieving laboratory reports from OLIS The readers are

expected to have an understanding of the business and technical requirements for querying and receiving laboratory report information from the Ontario

Laboratories Information System

Background 13

OLIS is a single provincial system that allows all laboratory information on human beings in Ontario to be exchanged electronically between practitioners and

laboratory service providers and provides the Ministry of Health and Long-Term Care (MOHLTC) with program management information OLIS facilitates the

exchange of laboratory information on human beings in Ontario amongst LIS HIS EMR and other point of service systems (POS) but it is not a LIS system in its

own right and is not intended to replace existing LIS systems OLIS has an existing HL7 v2 interface used by labs to submit results and Inquiry interface used by

clinical point of service (POS) systems

Primary intension of the OLIS FHIR interface is to provide an interface that can be used by patients to access their information in OLIS (consumer interface)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 4

Reference Materials 14

Table 1 Reference Materials

Document Name Location

HL7 FHIR STU3 httphl7orgfhir

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 5

2 How to Implement HL7 FHIR

Content Types and Encodings 21

The formal MIME-type for FHIR resources is applicationjson+fhir or applicationxml+fhir The correct mime type SHALL be used by clients and servers

JSON (preferred) applicationjson+fhir

XML (optional) applicationxml+fhir

FHIR uses UTF-8 for all request and response bodies Since the HTTP specification defines a default character encoding of ISO-8859-1 requests and responses

SHALL explicitly set the character encoding to UTF-8 using the charset parameter of the MIME-type in the Content-Type header Requests MAY also specify

this charset parameter in the Accept header andor use the Accept-Charset header

Summary of all FHIR Request Interactions

The table below shows the allowed transactions on FHIR resources and their corresponding HTTP operations

Table 2 OLIS FHIR HTTP Operations

Resource Transaction HTTP Verb

DiagnosticReport Search GET

DiagnosticReport Read GET

Special Case Missing data

In some cases implementers may find that they do not have appropriate data for an element with minimum cardinality = 1 In this case the element must be

present but unless the resource or a profile on it has made the actual value of the primitive data type mandatory it is possible to provide an extension that explains

why the primitive value is not present

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 6

XML

lturigt

ltextension url=httphl7orgfhirStructureDefinitiondata-absent-reasongt

ltvalueCode=unknowngt

ltextensiongt

lturigt

JSON

_uri

extension [

url httphl7orgfhirStructureDefinitiondata-absent-reason

valueCode unknown

]

In this example instead of a value a data missing code is provided (httpswwwhl7orgfhirextension-data-absent-reasonhtml) Note that it is not required that

this particular extension is used This extension is not a modifier extension because the primitive data type has no value

It is not valid to create a fictional piece of data for the primitive value and then to add an extension indicating that the data has been constructed to meet the data

rules This would be both a bad idea and also a modifier extension which is not allowed on data types

Naming Convention

The base URL for OLIS FHIR interface will be referred to as ldquo[base]rdquo in the sections and examples below Please note that base URL might change over time

The base for Naming System (namespace of identifiers and code system of local terminologies) is httpsehealthontariocaAPIFHIRNamingSystem For

globalshareable identifiers (eg Ontario health care number Ontario Physician License etc) this might be replaced with httphl7orgfhirNamingSystemca-

on-license-physician in the future when HL7 FHIR Naming System registry is available The base for global identifier namespaces will be referred to as [id-

system-global-base] in the sections and examples below The base for local identifier namespaces (eg placer group number order number etc) will be referred

to as ldquo[id-system-local-base]rdquo in the sections and examples below The base for local code systems (eg test request code) will be referred to as ldquo[code-system-local-

base]rdquo in the sections and examples below

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 7

Variable Value

[base] httpswsgatewayprodehealthontariocaAPIFHIRLaboratoryv1Diagnostic

Report

[base-structure] httpsehealthontariocaAPIFHIRStructureDefinition

[id-system-global-base] httpsehealthontariocaAPIFHIRNamingSystem

[id-system-local-base] httpsehealthontariocaAPIFHIRNamingSystem

[code-system-local-base] httpsehealthontariocaAPIFHIRNamingSystem

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 8

3 Supported Operations

Search Laboratory Report 31

This interaction searches a set of resources based on some filter criteria The interaction can be performed by several different HTTP commands

GET [base][type][parameters]amp_format=[mime-type]

This searches all resources of a particular type using the criteria represented in the parameters

All these search interactions take a series of parameters that are a series of name=value pairs encoded in the URL (See W3C HTML forms)

If the search fails (cannot be executed not that there is no matches) the return value is a status code 4xx or 5xx with an OperationOutcome If the search succeeds

the return content is a Bundle with type = searchset containing the results of the search as a list of resources in a defined order The result list can be long so server

will use paging (adapted from RFC 5005 (Feed Paging and Archiving) for breaking the list into pages if appropriate (see Paging section below) The server may also

return an OperationOutcome resource with additional information about the search

311 Search Parameter Types

Each search parameter is defined by a type that specifies how the search parameter behaves These are the defined parameter types

number Search parameter SHALL be a number (a whole number or a decimal)

date Search parameter is on a datetime The date format is the standard XML format

string Search parameter is a simple string like a name part Search is case-insensitive and accent-insensitive May match just the start of a string String

parameters may contain spaces

token Search parameter on a coded element or identifier May be used to search through the text displayname code and codecodesystem (for codes) and label

system and key (for identifier) Its value is either a string or a pair of namespace and value separated by a | depending on the modifier used

312 Prefixes

For the ordered parameter types of number date and quantity a prefix to the parameter value may be used to control the nature of the matching To avoid URL

escaping and visual confusion the following prefixes are used

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 9

eq the value for the parameter in the resource is equal to the provided value the range of the search value fully contains the range of the target value

gt the value for the parameter in the resource is greater than the provided value the range above the search value intersects (ie overlaps) with the

range of the target value

lt the value for the parameter in the resource is less than the provided value the range below the search value intersects (ie overlaps) with the

range of the target value

ge the value for the parameter in the resource is greater or equal to the provided value the range above the search value intersects (ie overlaps) with the

range of the target value or the range of the search value fully contains

the range of the target value

le the value for the parameter in the resource is less or equal to the provided value the range below the search value intersects (ie overlaps) with the

range of the target value or the range of the search value fully contains

the range of the target value

If no prefix is present the prefix eq is assumed

313 Supported Search Parameters

GET DiagnosticReport (query by Patient ID) o Patient ID parameter patientpatientidentifier

Only Ontario health card number is allowed as an ID parameter in the current release Example patientpatientidentifier=[id-system-global-base]ca-on-patient-hcn|12345678

o Patient Gender parameter gender patientgender Example patientgender=male

o Patient Date of Birth parameter patientbirthdate Example patientbirthdate=19291129

o Dates parameter issuedstart Example issuedstart=ge20160102

314 Search Example

GET [base] DiagnosticReportspatientpatientidentifier=[id-system-global-base]ca-on-patient-hcn| 1008624486amp patientgender=maleamppatientbirthdate=19291129ampissuedstart=ge20160102

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 10

4 FHIR Resources Definitions

General Overview 41

411 Supported Attributes

Only attributes described in the subsections below will be supported

412 Format

OLIS will support JSON and XML formats JSON is the preferred format

Infrastructure Resources 42

421 Resource - Base Resource Definitions

httpwwwhl7orgFHIRresourcehtml Name Card Type ValueVocab Description Comments id 01 id Unique ID set by FHIR server Logical id of this artifact meta 01 Meta Only ldquolastUpdatedrdquo element to be populated

by FHIR server Metadata about the resource

lastUpdated 01 instant This value changes each time the content of the resource changes

language 01 code Used only for Bundle and fixed to ldquoenrdquo in the current release

Language of the resource content

422 DomainResource Resource

httpwwwhl7orgFHIRdomainresourcehtml

A resource with narrative extensions and contained resources

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 11

If a resource is contained in another resource it SHALL NOT have a metaversionId or a metalastUpdated

If the resource is contained in another resource it SHALL be referred to from elsewhere in the resource

If the resource is contained in another resource it SHALL NOT contain nested Resources

If the resource is contained in another resource it SHALL NOT contain any narrative

Most resources are derived from Domain Resources - so they also can contain text contained resources extensions and data elements specific to the particular

domain of the resource

Name Card Type ValueVocab Description Comments text 01 Narrative Text summary of the resource for human

interpretation Not used in the current release

contained 0 Resource Contained inline Resources extension 0 Extension Additional Content defined by

implementations

modifierExtension

0 Extension Extensions that cannot be ignored

423 Bundle Resource

Based on httpwwwhl7orgFHIRbundlehtml

A special type of resource for collections of resources

A set of search results (type = searchset) consists of a series of zero or more entries Each entry element will contain a resource

Bundletotal may be used to return the total number of resources that match the search and that may be returned by following the next link

Name Card Type ValueVocab Description Comments type 11 code Fixed to ldquosearchsetrdquo Type of bundle total 01 unsignedI

nt The total number of matches

link 0 BackboneElement

Links related to this Bundle Optional element might be returned by a server

relation 11 string ldquoselfrdquo for the link to the this Bundle ldquonextrdquo for the link to the next page

ValueSet httpwwwianaorgassignmentslink-relationslink-relationsxhtml

url 11 uri Reference details for the link entry 0 Backbone

Element Entry in the bundle - will have a resource

or information

fullUrl 01 uri The fullUrl element must be present when a resource is present and not present otherwise

Absolute URL for resource (server address or UUIDOID)

resource 01 Resource A resource in the bundle

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 12

424 OperationOutcome Resource

Based on httphl7orgfhiroperationoutcomehtml

Operation Outcomes are sets of error warning and information messages that provide detailed information about the outcome of some attempted system

operation They are provided as a direct system response or component of one where they provide information about the outcome of the operation

OperationOutcomes are used in the following circumstances

When an RESTful operation fails

As the response on a validation operation to provide information about the outcomes

As part of a message response usually when the message has not been processed correctly

This resource is not used for reporting clinical or workflow issues associated with a proposed or ongoing action The resource is not designed to be persisted or

referenced from other parts of the workflow

Name Card

Type ValueVocab Description Comments

issue 1 BackboneElement

A single issue associated with the action

severity 11 code ValueSethttphl7orgfhirvalueset-issue-severityhtml

fatal | error | warning | information

code 11 ValueSethttphl7orgfhirvalueset-issue-typehtml

Error or warning code

details 01 CodeableConcept

ValueSet httphl7orgfhirvalueset-operation-outcomehtml

Additional details about the error

diagnostics 01 string Additional diagnostic information about the issue

location 0 string XPath of element(s) related to issue

425 Using Operation Outcome Resources

On the RESTful interface operation outcome resources are only relevant when a level of computable detail is required that is more granular than that provided by

the HTTP response codes This granularity could include

more detail about the location of an issue

the ability to identify multiple distinct issues

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 13

provision of finer error codes that connect to known business failure states

426 Reporting Errors in the HTTP Headers

Server may also need to report errors in the HTTP headers - especially query parameters when processing searches Errors are reported using a case sensitive

location that has two parts a fixed http and the header or query parameter name separated by a Some examples

Location Description

httpnameexact A reference to the search parameter name with the modifier exact

httpAuthorization A reference to the Authorization header - perhaps to indicate that it is missing and some form of authentication is required

427 OperationOutcome Example - Search

resourceType OperationOutcome

id OperationOutcome1234

issue [

severity fatal

code code-invalid

details

text The name parameter has the modifier exact which is not supported by this server

location [

httpnameexact

]

]

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 14

FHIR Resources 43

DiagnosticReport

PractitionerOrdering Practitioner

Extension ResultCopiestoPractitioners

PatientDiagnosticReportSubject

Organization

PerformingLab

DiagnosticReport

OrganizationReportingLab

ObservationDiagnosticReportResult

SpecimenDiagnosticReportSpecimen

ProcedureRequestDiagnosticReportProcedureRequest

PractitionerAttendingAdmitting

OrganizationExtension

SpecimenCollectorCenter

OrganizationExtension

DestinationLabOrderPlacer

Encounter

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 15

431 Diagnostic Report Profile

ca-on-Diagnostic-DiagnosticReport based on Diagnostic Report profile httphl7orgfhirdiagnosticreporthtml

Name Card Type ValueVocab Description Comments identifier 11 Identifier Identifier assigned by the sending

organization - this is an identifier assigned outside FHIR

This field contains an identifier for the entire order The Placer Group Number is conceptually equivalent to a requisition number assigned to all test requests in an order by an organization (ORC4)

system 11 Uri

The source of the lab reports (ORC43)

value 11 string The unique identifier of the lab report record (ORC41)

status 11 code Value set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

code CodeableConcept

coding 11 coding Fixed code ldquo11502-2rdquo Code defined by a LOINC text 11 string Fixed value ldquoLaboratory Reportrdquo Plain text representation of the concept

Subject (patient)

11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

issued 01 instant dateTime when test request has been issued An instant in time - known at least to the second and always includes a time zone This field will be populated by system (OBR22)

performer 01 Reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

The individual responsible for reporting test result Can be reporting laboratory or reporting practitioner

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 16

Name Card Type ValueVocab Description Comments reference 11 string A reference to a location at which the

other resource is found

request 1 Reference Contained ca-on-Diagnostic-ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

specimen 01 Reference Contained ca-on-Diagnostic-Specimen (Specimen) resource

Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

Result 1 Reference Contained ca-on-Diagnostic-Observation (Observation) resource

List of all the observation associated with the test request (OBX)

reference 11 string A reference to a location at which the other resource is found

codedDiagnosi

s

01 CodeableCon

cept

Value Set ICD10 Diagnosis information

coding 11 coding A reference to a location at which the other resource is found

text 11 string A reference to a location at which the other resource is found

432 Procedure Request Profile

ca-on-Diagnostic-ProcedureRequest profile based on httphl7orgfhirprocedurerequesthtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier assigned by the ordering facility - this is an identifier assigned outside FHIR Must contain a value assigned by the order-placing organization that uniquely identifies this test request among all test requests in OLIS (OBR2)

system 11 Uri The source of test request on the lab report (OBR23)

value 11 string The unique identifier of the test request record (OBR21)

This represents the test request number from the LIS or HIS systems

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 17

Name Card Type ValueVocab Description Comments

status 11 code Value Set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

intent 11 code Value set httphl7orgfhirValueSetrequest-intent

proposal | plan | original-order | order| reflex-order (OBR11)

If OBR11 contains lsquoGrsquo populate lsquoreflex-testrsquo value otherwise fix the value to lsquoOrderrsquo

priority 11 code Value set httphl7orgfhirValueSetrequest-priority

routine | urgent | asap | stat

RequestPriority (Required) (OBR276)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Context (encounter)

11 Reference Contained ca-on-Diagnostic-Encounter (Encounter) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

occuranceDateTime

11 dateTime When testing should occur (OBR274) For routine orders populate this field with the current date

For timing-critical orders populate this field with the date and time that the specimen is to be obtained

For future-dated orders populate this field with the scheduled future date (and time if applicable) when the laboratory test is to occur

extension

01 DateTime of Transaction (ORC9) Populate this field with the

date and time of the event

that initiated the current

transaction

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 18

url 11 httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-dateTime-transaction

valueDateTime 11 dateTime

requester 11 BackboneElement

agent 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the personorganization making request to perform the test (ordering practitionerorganization OBR16)

IF Ordering Facility exists in the message (ORC21) Scenario 1 requester (OBR16) is organization populate ORC21 with the same organization information that in OBR16 field Scenario 2 requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

onBehalfOf 01 reference Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the organization agent is acting for ordering facility

Should be mapped to ordering facility (ORC21 and ORC22) where requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension CCrsquod list practitioner (OBR28) url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-cc-practitioner-list

valueReference (Practitioner)

110 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Practitioners named on an order (attending admitting ccrsquod)

reference 11 string A reference to a location at which the

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 19

other resource is found extension 01 Extension Test Request Placer ZBR2

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-test-request-placer

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Original Test Request Placer

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension Destination Laboratory ZBR8 url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-destination-laboratory

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Destination Laboratory

reference 11 string A reference to a location at which the other resource is found

note 05 Annotation comments authorString 11 string ZNT segment Indicate the organization

(or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

extension 11 Extension Source of Comment (NTE2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-source-comment

valueString

11 string

extension 11 Extension Set ID (NTE1)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 20

set-id

valueString

11 string

433 Observation Profile

ca-on-Diagnostic-Observation profile based on httphl7orgfhirobservationhtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Unique ID for the particular observation (OBR3)

system 11 uri The namespace for the identifier (OBR32) value 11 string The value that is unique (OBR31)

status 11 code Value set Observation result status (OBX11) code CodeableCo

ncept Value set LOINCSNOMED CT

Test result code (OBX3)

coding 11 coding Code defined by a terminology system (OBX31)

text 11 string Plain text representation of the concept (OBX32)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

effective 01 Clinically relevant time for observation

effectiveDateTime

01 dateTime DateTime of observation OBX141 Use this field for ancillary order only

This field must be empty when a laboratory reports a test result

issued 11 instant Indicate the date and time that the Test Result was released by the Reporting Laboratory (ZBX1)

performer (organization)

11 Reference Contained ca-on-Deagnostic-Organization (Organization) Resource or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

The individual responsible for performing the test Can be laboratory or practitioner

reference 11 string A reference to a location at which the other resource is found

value 11 Actual result

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 21

Name Card Type ValueVocab Description Comments

valueQuantity 11 Quantity (OBX2)-Only numeric test value value 11 decimal Numeric value of the test result (OBX5) unit 01 string When observation Value is a scalar value this

field describes the units of measure (OBX61)

interpretation 01 CodebaleConcept

Observation Interpretation Codes(OBX8)

coding 01 Coding Value set method 01 CodebaleCo

ncept How the observation has been done (OBX17)

text 11 string Plain text (OBX172) specimen 01 Reference Contained ca-on-Diagnostic-

Specimen (Specimen) resource Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

referenceRange 01 BackboneElement

Normal range of value associated with observation result (OBX7)

text 11 string Text based reference range in an observation

extension 01 Extension Nature of Abnormal Test (OBX10)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-nature-abnormal-test

valuecoding

11 coding Value set

extension 01 Extension Observation sub-id (OBX4)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation sort key (ZBX2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation comment (NTE-ZNT)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 22

url 11 uri httpehealthontariocaAPIfhir

StructureDefinitiondiagnosticReport-ext-observation-comment

valueAnnotation

11 annotation

authorString

11 string ZNT segment Indicate the organization (or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

434 Specimen Profile

ca-on-Diagnostic-Specimen profile based on httphl7orgfhirspecimenhtml

Name Card Type ValueVocab Description Comments

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

receivedTime 11 dateTime The time when specimen was received for processing

OBR14

request 1 Reference Contained ca-on-Diagnostic- ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

extension 11 Extension Organization that collected the specimen

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-specimen-collector-center

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Specimen Collector Center (ZBR3)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 23

Name Card Type ValueVocab Description Comments

Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

reference 11 string A reference to a location at which the other resource is found

reference 11 string A reference to a location at which the other resource is found

collected 01 Specimen collection time CollectedPeriod 11 Period

start 01 dateTime Starting specimen time OBR7 end 01 dateTime End specimen time OBR8

type 01 CodeableConcept

Kind of material that forms the specimen (Specimen Type)

OBR15

coding 01 coding Value Set from OLIS Code define by the terminology system

OBR1511

text 01 string Plain text representation of the concept

OBR1512

bodySite 01 CodeableConcept

Value Set Anatomical collection site OBR155

container 01 BackboneElement

Direct container of specimen

identifier 02 identifier Id for container OBR18 andor OBR20 Referring Lab User Specimen Identifier and Performing Lab User Specimen Identifier on Refereed ndashout orders

specimenQuantity

01 SimpleQuantity

Quantity of specimen within container

OBR37

note 01 Annotation Collectors comments text 11 string Collectors comments OBR39

extension 01 Extension Collection volume (OBR9)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-collection-volume

valueQuantity

11 Quantity

value 11 decimal Numeric value of the collection OBR91

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 24

volume unit 01 string Units of measure OBR921

435 Patient Profile

ca-on-Diagnostic-Patient profile based on httphl7orgfhirpatienthtml

Name

Card Type ValueVocab Description Comment

identifier

1 Identifier An identifier for this patient

system 11 uri [id-system-global-base]ca-on-patient-hcn

Patient Identifier Assigning Authority Namespace in which set of possible id values is unique (PID391 PID392 PID393)

Value 11 string Patient Identifier Number The portion of the identifier typically displayed to the user and which is unique within the context of the system (PID31)

extension 01 Health Card Version code (PID311) this is an extension patient identifier

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionext-identifier-hcn-version-code

valueString 11 string name

01 HumanName

use 11 code Value set httphl7orgfhirValueSetname-use

Purpose of this name Name type code PID57

Fix to the official for all cases except for anonymous For anonymous code should be lsquoanonymousrsquo

family 11 string Patient Last Name (PID51) given 02 string Patient First Name(PID52) extension 01 patient middle name (PID53)

this is an extension of given name

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode 11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name (PID55)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 25

Name

Card Type ValueVocab Description Comment

suffix 02 String Parts that come after the name (PID54)

extension 01 Patient degree designation This is an extension of suffix

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoACrdquo Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

telecom 03 Demographics Patient table Telephone Number system 01 code httphl7orgfhir

ValueSetcontact-point-system

Telecommunications form for contact point (Phone fax email pager url sms other) PID133 or PID143

Value 11 string The actual contact point details PID134-PID138 Or PID144-PID148

use 01 code httphl7orgfhirValueSetcontact-point-use

Use of contact point (Home work temp old mobile) PID132 or PID142

gender 11 code ldquomalerdquo ldquofemalerdquo ldquootherrdquo ldquounknownrdquo (httphl7orgfhirValueSetadministrative-gender)

The gender of a person used for administrative purposes (PID8)

birthDate 11 date The date of birth for the individual (PID7) Deceased[x]

01 boolean|dateTime

Indicates if the individual is deceased or not The value must be one of the choices specified below but not both System creating instance of this resource must decide which type to use at run time (PID30)

deceasedBoolean

boolean true|false

deceasedDateTime

dateTime Deceased datetime if known (PID29)

address 12 Address Demographics Patient table Address for the individual (PID11)

use 11 code ValueSet httphl7orgfhir

Address Type The use of an address

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 26

Name

Card Type ValueVocab Description Comment

ValueSetaddress-use

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

line 11 string Street lines (PID111) city 11 string Name of city town etc (PID113) state 01 string Province or territory (PID114) postalCode 01 string Postal code for area (PID115) country 11 string Country (can be ISO 3166 3 letter code) (PID116)

436 Practitioner Profile (Ordering Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent Ordering Practitioner information

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR1622

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR161

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR162 given 12 string Practitioner First Name OBR163

extension

01 Practitioner middle name this is an extension of given name

OBR164

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 3: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide

Significant Contributors

Name Title Organization Contact

Natalya Pogrebetsky Sr Standards Analyst eHealth Ontario

Sanjaai Udukumbura

Solutions Architect eHealth Ontario

Approval History Approver(s) Title

OLIS FHIR IG Revision History Version No

Date Summary of Change Changed By

01 26 April 2017 Initial version Natalya Pogrebetsky

eHealth Ontario OLIS FHIR Interface Implementation Guide Page i

Table of Contents 1 Introduction 3

Summary and Scope 3 11

Intended Audience 3 12

Background 3 13

Reference Materials 4 14

2 How to Implement HL7 FHIR 5 Content Types and Encodings 5 21

Summary of all FHIR Request Interactions 5 Special Case Missing data 5 Naming Convention 6

3 Supported Operations 8 Search Laboratory Report 8 31

311 Search Parameter Types 8 312 Prefixes 8 313 Supported Search Parameters 9 314 Search Example 9

4 FHIR Resources Definitions 10 General Overview 10 41

411 Supported Attributes 10 412 Format 10

Infrastructure Resources 10 42

421 Resource - Base Resource Definitions 10 422 DomainResource Resource 10 423 Bundle Resource 11 424 OperationOutcome Resource 12 425 Using Operation Outcome Resources 12 426 Reporting Errors in the HTTP Headers 13 427 OperationOutcome Example - Search 13

FHIR Resources 14 43

431 Diagnostic Report Profile 15 432 Procedure Request Profile 16 433 Observation Profile 20 434 Specimen Profile 22 435 Patient Profile 24 436 Practitioner Profile (Ordering Practitioner) 26 437 Practitioner Profile (CC List Practitioner) 27 438 Practitioner Profile (Attending Practitioner) 29 439 Practitioner Profile (Admitting Practitioner) 30 4310 Organization Profile (Ordering Facility) 31 4311 Organization Profile (Performing Laboratory) 31 4312 Organization Profile (Reporting Laboratory) 32 4313 Organization Profile (Specimen Collector Center) 33

eHealth Ontario OLIS FHIR Interface Implementation Guide Page ii

4314 Organization Profile (Test Request Placer) 33 4315 Organization Profile (Destination Laboratory) 34 4316 Encounter Profile 34

Data Type Notes 35 44

441 Date 35 442 DateTime 35 443 Time 36 444 URI 36

Appendix A JWT Autorisation header 37 HTTP Response Codes 37 IANA Defined HTTP Status Codes 37

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 3

1 Introduction

Summary and Scope 11

The purpose of this document is to capture solution design for Ontario Laboratories Information System (OLIS) It establishes a common understanding amongst

the stakeholder groups of the solution design needed development and implementation of the OLIS Solution The scope of this document will evolve over the

lifecycle of the project

Intended Audience 12

The intended audiences of this document are business and technical implementers who are interested in retrieving laboratory reports from OLIS The readers are

expected to have an understanding of the business and technical requirements for querying and receiving laboratory report information from the Ontario

Laboratories Information System

Background 13

OLIS is a single provincial system that allows all laboratory information on human beings in Ontario to be exchanged electronically between practitioners and

laboratory service providers and provides the Ministry of Health and Long-Term Care (MOHLTC) with program management information OLIS facilitates the

exchange of laboratory information on human beings in Ontario amongst LIS HIS EMR and other point of service systems (POS) but it is not a LIS system in its

own right and is not intended to replace existing LIS systems OLIS has an existing HL7 v2 interface used by labs to submit results and Inquiry interface used by

clinical point of service (POS) systems

Primary intension of the OLIS FHIR interface is to provide an interface that can be used by patients to access their information in OLIS (consumer interface)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 4

Reference Materials 14

Table 1 Reference Materials

Document Name Location

HL7 FHIR STU3 httphl7orgfhir

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 5

2 How to Implement HL7 FHIR

Content Types and Encodings 21

The formal MIME-type for FHIR resources is applicationjson+fhir or applicationxml+fhir The correct mime type SHALL be used by clients and servers

JSON (preferred) applicationjson+fhir

XML (optional) applicationxml+fhir

FHIR uses UTF-8 for all request and response bodies Since the HTTP specification defines a default character encoding of ISO-8859-1 requests and responses

SHALL explicitly set the character encoding to UTF-8 using the charset parameter of the MIME-type in the Content-Type header Requests MAY also specify

this charset parameter in the Accept header andor use the Accept-Charset header

Summary of all FHIR Request Interactions

The table below shows the allowed transactions on FHIR resources and their corresponding HTTP operations

Table 2 OLIS FHIR HTTP Operations

Resource Transaction HTTP Verb

DiagnosticReport Search GET

DiagnosticReport Read GET

Special Case Missing data

In some cases implementers may find that they do not have appropriate data for an element with minimum cardinality = 1 In this case the element must be

present but unless the resource or a profile on it has made the actual value of the primitive data type mandatory it is possible to provide an extension that explains

why the primitive value is not present

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 6

XML

lturigt

ltextension url=httphl7orgfhirStructureDefinitiondata-absent-reasongt

ltvalueCode=unknowngt

ltextensiongt

lturigt

JSON

_uri

extension [

url httphl7orgfhirStructureDefinitiondata-absent-reason

valueCode unknown

]

In this example instead of a value a data missing code is provided (httpswwwhl7orgfhirextension-data-absent-reasonhtml) Note that it is not required that

this particular extension is used This extension is not a modifier extension because the primitive data type has no value

It is not valid to create a fictional piece of data for the primitive value and then to add an extension indicating that the data has been constructed to meet the data

rules This would be both a bad idea and also a modifier extension which is not allowed on data types

Naming Convention

The base URL for OLIS FHIR interface will be referred to as ldquo[base]rdquo in the sections and examples below Please note that base URL might change over time

The base for Naming System (namespace of identifiers and code system of local terminologies) is httpsehealthontariocaAPIFHIRNamingSystem For

globalshareable identifiers (eg Ontario health care number Ontario Physician License etc) this might be replaced with httphl7orgfhirNamingSystemca-

on-license-physician in the future when HL7 FHIR Naming System registry is available The base for global identifier namespaces will be referred to as [id-

system-global-base] in the sections and examples below The base for local identifier namespaces (eg placer group number order number etc) will be referred

to as ldquo[id-system-local-base]rdquo in the sections and examples below The base for local code systems (eg test request code) will be referred to as ldquo[code-system-local-

base]rdquo in the sections and examples below

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 7

Variable Value

[base] httpswsgatewayprodehealthontariocaAPIFHIRLaboratoryv1Diagnostic

Report

[base-structure] httpsehealthontariocaAPIFHIRStructureDefinition

[id-system-global-base] httpsehealthontariocaAPIFHIRNamingSystem

[id-system-local-base] httpsehealthontariocaAPIFHIRNamingSystem

[code-system-local-base] httpsehealthontariocaAPIFHIRNamingSystem

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 8

3 Supported Operations

Search Laboratory Report 31

This interaction searches a set of resources based on some filter criteria The interaction can be performed by several different HTTP commands

GET [base][type][parameters]amp_format=[mime-type]

This searches all resources of a particular type using the criteria represented in the parameters

All these search interactions take a series of parameters that are a series of name=value pairs encoded in the URL (See W3C HTML forms)

If the search fails (cannot be executed not that there is no matches) the return value is a status code 4xx or 5xx with an OperationOutcome If the search succeeds

the return content is a Bundle with type = searchset containing the results of the search as a list of resources in a defined order The result list can be long so server

will use paging (adapted from RFC 5005 (Feed Paging and Archiving) for breaking the list into pages if appropriate (see Paging section below) The server may also

return an OperationOutcome resource with additional information about the search

311 Search Parameter Types

Each search parameter is defined by a type that specifies how the search parameter behaves These are the defined parameter types

number Search parameter SHALL be a number (a whole number or a decimal)

date Search parameter is on a datetime The date format is the standard XML format

string Search parameter is a simple string like a name part Search is case-insensitive and accent-insensitive May match just the start of a string String

parameters may contain spaces

token Search parameter on a coded element or identifier May be used to search through the text displayname code and codecodesystem (for codes) and label

system and key (for identifier) Its value is either a string or a pair of namespace and value separated by a | depending on the modifier used

312 Prefixes

For the ordered parameter types of number date and quantity a prefix to the parameter value may be used to control the nature of the matching To avoid URL

escaping and visual confusion the following prefixes are used

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 9

eq the value for the parameter in the resource is equal to the provided value the range of the search value fully contains the range of the target value

gt the value for the parameter in the resource is greater than the provided value the range above the search value intersects (ie overlaps) with the

range of the target value

lt the value for the parameter in the resource is less than the provided value the range below the search value intersects (ie overlaps) with the

range of the target value

ge the value for the parameter in the resource is greater or equal to the provided value the range above the search value intersects (ie overlaps) with the

range of the target value or the range of the search value fully contains

the range of the target value

le the value for the parameter in the resource is less or equal to the provided value the range below the search value intersects (ie overlaps) with the

range of the target value or the range of the search value fully contains

the range of the target value

If no prefix is present the prefix eq is assumed

313 Supported Search Parameters

GET DiagnosticReport (query by Patient ID) o Patient ID parameter patientpatientidentifier

Only Ontario health card number is allowed as an ID parameter in the current release Example patientpatientidentifier=[id-system-global-base]ca-on-patient-hcn|12345678

o Patient Gender parameter gender patientgender Example patientgender=male

o Patient Date of Birth parameter patientbirthdate Example patientbirthdate=19291129

o Dates parameter issuedstart Example issuedstart=ge20160102

314 Search Example

GET [base] DiagnosticReportspatientpatientidentifier=[id-system-global-base]ca-on-patient-hcn| 1008624486amp patientgender=maleamppatientbirthdate=19291129ampissuedstart=ge20160102

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 10

4 FHIR Resources Definitions

General Overview 41

411 Supported Attributes

Only attributes described in the subsections below will be supported

412 Format

OLIS will support JSON and XML formats JSON is the preferred format

Infrastructure Resources 42

421 Resource - Base Resource Definitions

httpwwwhl7orgFHIRresourcehtml Name Card Type ValueVocab Description Comments id 01 id Unique ID set by FHIR server Logical id of this artifact meta 01 Meta Only ldquolastUpdatedrdquo element to be populated

by FHIR server Metadata about the resource

lastUpdated 01 instant This value changes each time the content of the resource changes

language 01 code Used only for Bundle and fixed to ldquoenrdquo in the current release

Language of the resource content

422 DomainResource Resource

httpwwwhl7orgFHIRdomainresourcehtml

A resource with narrative extensions and contained resources

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 11

If a resource is contained in another resource it SHALL NOT have a metaversionId or a metalastUpdated

If the resource is contained in another resource it SHALL be referred to from elsewhere in the resource

If the resource is contained in another resource it SHALL NOT contain nested Resources

If the resource is contained in another resource it SHALL NOT contain any narrative

Most resources are derived from Domain Resources - so they also can contain text contained resources extensions and data elements specific to the particular

domain of the resource

Name Card Type ValueVocab Description Comments text 01 Narrative Text summary of the resource for human

interpretation Not used in the current release

contained 0 Resource Contained inline Resources extension 0 Extension Additional Content defined by

implementations

modifierExtension

0 Extension Extensions that cannot be ignored

423 Bundle Resource

Based on httpwwwhl7orgFHIRbundlehtml

A special type of resource for collections of resources

A set of search results (type = searchset) consists of a series of zero or more entries Each entry element will contain a resource

Bundletotal may be used to return the total number of resources that match the search and that may be returned by following the next link

Name Card Type ValueVocab Description Comments type 11 code Fixed to ldquosearchsetrdquo Type of bundle total 01 unsignedI

nt The total number of matches

link 0 BackboneElement

Links related to this Bundle Optional element might be returned by a server

relation 11 string ldquoselfrdquo for the link to the this Bundle ldquonextrdquo for the link to the next page

ValueSet httpwwwianaorgassignmentslink-relationslink-relationsxhtml

url 11 uri Reference details for the link entry 0 Backbone

Element Entry in the bundle - will have a resource

or information

fullUrl 01 uri The fullUrl element must be present when a resource is present and not present otherwise

Absolute URL for resource (server address or UUIDOID)

resource 01 Resource A resource in the bundle

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 12

424 OperationOutcome Resource

Based on httphl7orgfhiroperationoutcomehtml

Operation Outcomes are sets of error warning and information messages that provide detailed information about the outcome of some attempted system

operation They are provided as a direct system response or component of one where they provide information about the outcome of the operation

OperationOutcomes are used in the following circumstances

When an RESTful operation fails

As the response on a validation operation to provide information about the outcomes

As part of a message response usually when the message has not been processed correctly

This resource is not used for reporting clinical or workflow issues associated with a proposed or ongoing action The resource is not designed to be persisted or

referenced from other parts of the workflow

Name Card

Type ValueVocab Description Comments

issue 1 BackboneElement

A single issue associated with the action

severity 11 code ValueSethttphl7orgfhirvalueset-issue-severityhtml

fatal | error | warning | information

code 11 ValueSethttphl7orgfhirvalueset-issue-typehtml

Error or warning code

details 01 CodeableConcept

ValueSet httphl7orgfhirvalueset-operation-outcomehtml

Additional details about the error

diagnostics 01 string Additional diagnostic information about the issue

location 0 string XPath of element(s) related to issue

425 Using Operation Outcome Resources

On the RESTful interface operation outcome resources are only relevant when a level of computable detail is required that is more granular than that provided by

the HTTP response codes This granularity could include

more detail about the location of an issue

the ability to identify multiple distinct issues

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 13

provision of finer error codes that connect to known business failure states

426 Reporting Errors in the HTTP Headers

Server may also need to report errors in the HTTP headers - especially query parameters when processing searches Errors are reported using a case sensitive

location that has two parts a fixed http and the header or query parameter name separated by a Some examples

Location Description

httpnameexact A reference to the search parameter name with the modifier exact

httpAuthorization A reference to the Authorization header - perhaps to indicate that it is missing and some form of authentication is required

427 OperationOutcome Example - Search

resourceType OperationOutcome

id OperationOutcome1234

issue [

severity fatal

code code-invalid

details

text The name parameter has the modifier exact which is not supported by this server

location [

httpnameexact

]

]

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 14

FHIR Resources 43

DiagnosticReport

PractitionerOrdering Practitioner

Extension ResultCopiestoPractitioners

PatientDiagnosticReportSubject

Organization

PerformingLab

DiagnosticReport

OrganizationReportingLab

ObservationDiagnosticReportResult

SpecimenDiagnosticReportSpecimen

ProcedureRequestDiagnosticReportProcedureRequest

PractitionerAttendingAdmitting

OrganizationExtension

SpecimenCollectorCenter

OrganizationExtension

DestinationLabOrderPlacer

Encounter

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 15

431 Diagnostic Report Profile

ca-on-Diagnostic-DiagnosticReport based on Diagnostic Report profile httphl7orgfhirdiagnosticreporthtml

Name Card Type ValueVocab Description Comments identifier 11 Identifier Identifier assigned by the sending

organization - this is an identifier assigned outside FHIR

This field contains an identifier for the entire order The Placer Group Number is conceptually equivalent to a requisition number assigned to all test requests in an order by an organization (ORC4)

system 11 Uri

The source of the lab reports (ORC43)

value 11 string The unique identifier of the lab report record (ORC41)

status 11 code Value set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

code CodeableConcept

coding 11 coding Fixed code ldquo11502-2rdquo Code defined by a LOINC text 11 string Fixed value ldquoLaboratory Reportrdquo Plain text representation of the concept

Subject (patient)

11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

issued 01 instant dateTime when test request has been issued An instant in time - known at least to the second and always includes a time zone This field will be populated by system (OBR22)

performer 01 Reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

The individual responsible for reporting test result Can be reporting laboratory or reporting practitioner

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 16

Name Card Type ValueVocab Description Comments reference 11 string A reference to a location at which the

other resource is found

request 1 Reference Contained ca-on-Diagnostic-ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

specimen 01 Reference Contained ca-on-Diagnostic-Specimen (Specimen) resource

Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

Result 1 Reference Contained ca-on-Diagnostic-Observation (Observation) resource

List of all the observation associated with the test request (OBX)

reference 11 string A reference to a location at which the other resource is found

codedDiagnosi

s

01 CodeableCon

cept

Value Set ICD10 Diagnosis information

coding 11 coding A reference to a location at which the other resource is found

text 11 string A reference to a location at which the other resource is found

432 Procedure Request Profile

ca-on-Diagnostic-ProcedureRequest profile based on httphl7orgfhirprocedurerequesthtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier assigned by the ordering facility - this is an identifier assigned outside FHIR Must contain a value assigned by the order-placing organization that uniquely identifies this test request among all test requests in OLIS (OBR2)

system 11 Uri The source of test request on the lab report (OBR23)

value 11 string The unique identifier of the test request record (OBR21)

This represents the test request number from the LIS or HIS systems

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 17

Name Card Type ValueVocab Description Comments

status 11 code Value Set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

intent 11 code Value set httphl7orgfhirValueSetrequest-intent

proposal | plan | original-order | order| reflex-order (OBR11)

If OBR11 contains lsquoGrsquo populate lsquoreflex-testrsquo value otherwise fix the value to lsquoOrderrsquo

priority 11 code Value set httphl7orgfhirValueSetrequest-priority

routine | urgent | asap | stat

RequestPriority (Required) (OBR276)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Context (encounter)

11 Reference Contained ca-on-Diagnostic-Encounter (Encounter) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

occuranceDateTime

11 dateTime When testing should occur (OBR274) For routine orders populate this field with the current date

For timing-critical orders populate this field with the date and time that the specimen is to be obtained

For future-dated orders populate this field with the scheduled future date (and time if applicable) when the laboratory test is to occur

extension

01 DateTime of Transaction (ORC9) Populate this field with the

date and time of the event

that initiated the current

transaction

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 18

url 11 httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-dateTime-transaction

valueDateTime 11 dateTime

requester 11 BackboneElement

agent 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the personorganization making request to perform the test (ordering practitionerorganization OBR16)

IF Ordering Facility exists in the message (ORC21) Scenario 1 requester (OBR16) is organization populate ORC21 with the same organization information that in OBR16 field Scenario 2 requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

onBehalfOf 01 reference Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the organization agent is acting for ordering facility

Should be mapped to ordering facility (ORC21 and ORC22) where requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension CCrsquod list practitioner (OBR28) url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-cc-practitioner-list

valueReference (Practitioner)

110 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Practitioners named on an order (attending admitting ccrsquod)

reference 11 string A reference to a location at which the

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 19

other resource is found extension 01 Extension Test Request Placer ZBR2

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-test-request-placer

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Original Test Request Placer

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension Destination Laboratory ZBR8 url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-destination-laboratory

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Destination Laboratory

reference 11 string A reference to a location at which the other resource is found

note 05 Annotation comments authorString 11 string ZNT segment Indicate the organization

(or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

extension 11 Extension Source of Comment (NTE2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-source-comment

valueString

11 string

extension 11 Extension Set ID (NTE1)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 20

set-id

valueString

11 string

433 Observation Profile

ca-on-Diagnostic-Observation profile based on httphl7orgfhirobservationhtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Unique ID for the particular observation (OBR3)

system 11 uri The namespace for the identifier (OBR32) value 11 string The value that is unique (OBR31)

status 11 code Value set Observation result status (OBX11) code CodeableCo

ncept Value set LOINCSNOMED CT

Test result code (OBX3)

coding 11 coding Code defined by a terminology system (OBX31)

text 11 string Plain text representation of the concept (OBX32)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

effective 01 Clinically relevant time for observation

effectiveDateTime

01 dateTime DateTime of observation OBX141 Use this field for ancillary order only

This field must be empty when a laboratory reports a test result

issued 11 instant Indicate the date and time that the Test Result was released by the Reporting Laboratory (ZBX1)

performer (organization)

11 Reference Contained ca-on-Deagnostic-Organization (Organization) Resource or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

The individual responsible for performing the test Can be laboratory or practitioner

reference 11 string A reference to a location at which the other resource is found

value 11 Actual result

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 21

Name Card Type ValueVocab Description Comments

valueQuantity 11 Quantity (OBX2)-Only numeric test value value 11 decimal Numeric value of the test result (OBX5) unit 01 string When observation Value is a scalar value this

field describes the units of measure (OBX61)

interpretation 01 CodebaleConcept

Observation Interpretation Codes(OBX8)

coding 01 Coding Value set method 01 CodebaleCo

ncept How the observation has been done (OBX17)

text 11 string Plain text (OBX172) specimen 01 Reference Contained ca-on-Diagnostic-

Specimen (Specimen) resource Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

referenceRange 01 BackboneElement

Normal range of value associated with observation result (OBX7)

text 11 string Text based reference range in an observation

extension 01 Extension Nature of Abnormal Test (OBX10)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-nature-abnormal-test

valuecoding

11 coding Value set

extension 01 Extension Observation sub-id (OBX4)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation sort key (ZBX2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation comment (NTE-ZNT)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 22

url 11 uri httpehealthontariocaAPIfhir

StructureDefinitiondiagnosticReport-ext-observation-comment

valueAnnotation

11 annotation

authorString

11 string ZNT segment Indicate the organization (or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

434 Specimen Profile

ca-on-Diagnostic-Specimen profile based on httphl7orgfhirspecimenhtml

Name Card Type ValueVocab Description Comments

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

receivedTime 11 dateTime The time when specimen was received for processing

OBR14

request 1 Reference Contained ca-on-Diagnostic- ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

extension 11 Extension Organization that collected the specimen

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-specimen-collector-center

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Specimen Collector Center (ZBR3)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 23

Name Card Type ValueVocab Description Comments

Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

reference 11 string A reference to a location at which the other resource is found

reference 11 string A reference to a location at which the other resource is found

collected 01 Specimen collection time CollectedPeriod 11 Period

start 01 dateTime Starting specimen time OBR7 end 01 dateTime End specimen time OBR8

type 01 CodeableConcept

Kind of material that forms the specimen (Specimen Type)

OBR15

coding 01 coding Value Set from OLIS Code define by the terminology system

OBR1511

text 01 string Plain text representation of the concept

OBR1512

bodySite 01 CodeableConcept

Value Set Anatomical collection site OBR155

container 01 BackboneElement

Direct container of specimen

identifier 02 identifier Id for container OBR18 andor OBR20 Referring Lab User Specimen Identifier and Performing Lab User Specimen Identifier on Refereed ndashout orders

specimenQuantity

01 SimpleQuantity

Quantity of specimen within container

OBR37

note 01 Annotation Collectors comments text 11 string Collectors comments OBR39

extension 01 Extension Collection volume (OBR9)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-collection-volume

valueQuantity

11 Quantity

value 11 decimal Numeric value of the collection OBR91

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 24

volume unit 01 string Units of measure OBR921

435 Patient Profile

ca-on-Diagnostic-Patient profile based on httphl7orgfhirpatienthtml

Name

Card Type ValueVocab Description Comment

identifier

1 Identifier An identifier for this patient

system 11 uri [id-system-global-base]ca-on-patient-hcn

Patient Identifier Assigning Authority Namespace in which set of possible id values is unique (PID391 PID392 PID393)

Value 11 string Patient Identifier Number The portion of the identifier typically displayed to the user and which is unique within the context of the system (PID31)

extension 01 Health Card Version code (PID311) this is an extension patient identifier

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionext-identifier-hcn-version-code

valueString 11 string name

01 HumanName

use 11 code Value set httphl7orgfhirValueSetname-use

Purpose of this name Name type code PID57

Fix to the official for all cases except for anonymous For anonymous code should be lsquoanonymousrsquo

family 11 string Patient Last Name (PID51) given 02 string Patient First Name(PID52) extension 01 patient middle name (PID53)

this is an extension of given name

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode 11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name (PID55)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 25

Name

Card Type ValueVocab Description Comment

suffix 02 String Parts that come after the name (PID54)

extension 01 Patient degree designation This is an extension of suffix

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoACrdquo Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

telecom 03 Demographics Patient table Telephone Number system 01 code httphl7orgfhir

ValueSetcontact-point-system

Telecommunications form for contact point (Phone fax email pager url sms other) PID133 or PID143

Value 11 string The actual contact point details PID134-PID138 Or PID144-PID148

use 01 code httphl7orgfhirValueSetcontact-point-use

Use of contact point (Home work temp old mobile) PID132 or PID142

gender 11 code ldquomalerdquo ldquofemalerdquo ldquootherrdquo ldquounknownrdquo (httphl7orgfhirValueSetadministrative-gender)

The gender of a person used for administrative purposes (PID8)

birthDate 11 date The date of birth for the individual (PID7) Deceased[x]

01 boolean|dateTime

Indicates if the individual is deceased or not The value must be one of the choices specified below but not both System creating instance of this resource must decide which type to use at run time (PID30)

deceasedBoolean

boolean true|false

deceasedDateTime

dateTime Deceased datetime if known (PID29)

address 12 Address Demographics Patient table Address for the individual (PID11)

use 11 code ValueSet httphl7orgfhir

Address Type The use of an address

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 26

Name

Card Type ValueVocab Description Comment

ValueSetaddress-use

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

line 11 string Street lines (PID111) city 11 string Name of city town etc (PID113) state 01 string Province or territory (PID114) postalCode 01 string Postal code for area (PID115) country 11 string Country (can be ISO 3166 3 letter code) (PID116)

436 Practitioner Profile (Ordering Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent Ordering Practitioner information

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR1622

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR161

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR162 given 12 string Practitioner First Name OBR163

extension

01 Practitioner middle name this is an extension of given name

OBR164

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 4: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page i

Table of Contents 1 Introduction 3

Summary and Scope 3 11

Intended Audience 3 12

Background 3 13

Reference Materials 4 14

2 How to Implement HL7 FHIR 5 Content Types and Encodings 5 21

Summary of all FHIR Request Interactions 5 Special Case Missing data 5 Naming Convention 6

3 Supported Operations 8 Search Laboratory Report 8 31

311 Search Parameter Types 8 312 Prefixes 8 313 Supported Search Parameters 9 314 Search Example 9

4 FHIR Resources Definitions 10 General Overview 10 41

411 Supported Attributes 10 412 Format 10

Infrastructure Resources 10 42

421 Resource - Base Resource Definitions 10 422 DomainResource Resource 10 423 Bundle Resource 11 424 OperationOutcome Resource 12 425 Using Operation Outcome Resources 12 426 Reporting Errors in the HTTP Headers 13 427 OperationOutcome Example - Search 13

FHIR Resources 14 43

431 Diagnostic Report Profile 15 432 Procedure Request Profile 16 433 Observation Profile 20 434 Specimen Profile 22 435 Patient Profile 24 436 Practitioner Profile (Ordering Practitioner) 26 437 Practitioner Profile (CC List Practitioner) 27 438 Practitioner Profile (Attending Practitioner) 29 439 Practitioner Profile (Admitting Practitioner) 30 4310 Organization Profile (Ordering Facility) 31 4311 Organization Profile (Performing Laboratory) 31 4312 Organization Profile (Reporting Laboratory) 32 4313 Organization Profile (Specimen Collector Center) 33

eHealth Ontario OLIS FHIR Interface Implementation Guide Page ii

4314 Organization Profile (Test Request Placer) 33 4315 Organization Profile (Destination Laboratory) 34 4316 Encounter Profile 34

Data Type Notes 35 44

441 Date 35 442 DateTime 35 443 Time 36 444 URI 36

Appendix A JWT Autorisation header 37 HTTP Response Codes 37 IANA Defined HTTP Status Codes 37

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 3

1 Introduction

Summary and Scope 11

The purpose of this document is to capture solution design for Ontario Laboratories Information System (OLIS) It establishes a common understanding amongst

the stakeholder groups of the solution design needed development and implementation of the OLIS Solution The scope of this document will evolve over the

lifecycle of the project

Intended Audience 12

The intended audiences of this document are business and technical implementers who are interested in retrieving laboratory reports from OLIS The readers are

expected to have an understanding of the business and technical requirements for querying and receiving laboratory report information from the Ontario

Laboratories Information System

Background 13

OLIS is a single provincial system that allows all laboratory information on human beings in Ontario to be exchanged electronically between practitioners and

laboratory service providers and provides the Ministry of Health and Long-Term Care (MOHLTC) with program management information OLIS facilitates the

exchange of laboratory information on human beings in Ontario amongst LIS HIS EMR and other point of service systems (POS) but it is not a LIS system in its

own right and is not intended to replace existing LIS systems OLIS has an existing HL7 v2 interface used by labs to submit results and Inquiry interface used by

clinical point of service (POS) systems

Primary intension of the OLIS FHIR interface is to provide an interface that can be used by patients to access their information in OLIS (consumer interface)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 4

Reference Materials 14

Table 1 Reference Materials

Document Name Location

HL7 FHIR STU3 httphl7orgfhir

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 5

2 How to Implement HL7 FHIR

Content Types and Encodings 21

The formal MIME-type for FHIR resources is applicationjson+fhir or applicationxml+fhir The correct mime type SHALL be used by clients and servers

JSON (preferred) applicationjson+fhir

XML (optional) applicationxml+fhir

FHIR uses UTF-8 for all request and response bodies Since the HTTP specification defines a default character encoding of ISO-8859-1 requests and responses

SHALL explicitly set the character encoding to UTF-8 using the charset parameter of the MIME-type in the Content-Type header Requests MAY also specify

this charset parameter in the Accept header andor use the Accept-Charset header

Summary of all FHIR Request Interactions

The table below shows the allowed transactions on FHIR resources and their corresponding HTTP operations

Table 2 OLIS FHIR HTTP Operations

Resource Transaction HTTP Verb

DiagnosticReport Search GET

DiagnosticReport Read GET

Special Case Missing data

In some cases implementers may find that they do not have appropriate data for an element with minimum cardinality = 1 In this case the element must be

present but unless the resource or a profile on it has made the actual value of the primitive data type mandatory it is possible to provide an extension that explains

why the primitive value is not present

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 6

XML

lturigt

ltextension url=httphl7orgfhirStructureDefinitiondata-absent-reasongt

ltvalueCode=unknowngt

ltextensiongt

lturigt

JSON

_uri

extension [

url httphl7orgfhirStructureDefinitiondata-absent-reason

valueCode unknown

]

In this example instead of a value a data missing code is provided (httpswwwhl7orgfhirextension-data-absent-reasonhtml) Note that it is not required that

this particular extension is used This extension is not a modifier extension because the primitive data type has no value

It is not valid to create a fictional piece of data for the primitive value and then to add an extension indicating that the data has been constructed to meet the data

rules This would be both a bad idea and also a modifier extension which is not allowed on data types

Naming Convention

The base URL for OLIS FHIR interface will be referred to as ldquo[base]rdquo in the sections and examples below Please note that base URL might change over time

The base for Naming System (namespace of identifiers and code system of local terminologies) is httpsehealthontariocaAPIFHIRNamingSystem For

globalshareable identifiers (eg Ontario health care number Ontario Physician License etc) this might be replaced with httphl7orgfhirNamingSystemca-

on-license-physician in the future when HL7 FHIR Naming System registry is available The base for global identifier namespaces will be referred to as [id-

system-global-base] in the sections and examples below The base for local identifier namespaces (eg placer group number order number etc) will be referred

to as ldquo[id-system-local-base]rdquo in the sections and examples below The base for local code systems (eg test request code) will be referred to as ldquo[code-system-local-

base]rdquo in the sections and examples below

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 7

Variable Value

[base] httpswsgatewayprodehealthontariocaAPIFHIRLaboratoryv1Diagnostic

Report

[base-structure] httpsehealthontariocaAPIFHIRStructureDefinition

[id-system-global-base] httpsehealthontariocaAPIFHIRNamingSystem

[id-system-local-base] httpsehealthontariocaAPIFHIRNamingSystem

[code-system-local-base] httpsehealthontariocaAPIFHIRNamingSystem

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 8

3 Supported Operations

Search Laboratory Report 31

This interaction searches a set of resources based on some filter criteria The interaction can be performed by several different HTTP commands

GET [base][type][parameters]amp_format=[mime-type]

This searches all resources of a particular type using the criteria represented in the parameters

All these search interactions take a series of parameters that are a series of name=value pairs encoded in the URL (See W3C HTML forms)

If the search fails (cannot be executed not that there is no matches) the return value is a status code 4xx or 5xx with an OperationOutcome If the search succeeds

the return content is a Bundle with type = searchset containing the results of the search as a list of resources in a defined order The result list can be long so server

will use paging (adapted from RFC 5005 (Feed Paging and Archiving) for breaking the list into pages if appropriate (see Paging section below) The server may also

return an OperationOutcome resource with additional information about the search

311 Search Parameter Types

Each search parameter is defined by a type that specifies how the search parameter behaves These are the defined parameter types

number Search parameter SHALL be a number (a whole number or a decimal)

date Search parameter is on a datetime The date format is the standard XML format

string Search parameter is a simple string like a name part Search is case-insensitive and accent-insensitive May match just the start of a string String

parameters may contain spaces

token Search parameter on a coded element or identifier May be used to search through the text displayname code and codecodesystem (for codes) and label

system and key (for identifier) Its value is either a string or a pair of namespace and value separated by a | depending on the modifier used

312 Prefixes

For the ordered parameter types of number date and quantity a prefix to the parameter value may be used to control the nature of the matching To avoid URL

escaping and visual confusion the following prefixes are used

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 9

eq the value for the parameter in the resource is equal to the provided value the range of the search value fully contains the range of the target value

gt the value for the parameter in the resource is greater than the provided value the range above the search value intersects (ie overlaps) with the

range of the target value

lt the value for the parameter in the resource is less than the provided value the range below the search value intersects (ie overlaps) with the

range of the target value

ge the value for the parameter in the resource is greater or equal to the provided value the range above the search value intersects (ie overlaps) with the

range of the target value or the range of the search value fully contains

the range of the target value

le the value for the parameter in the resource is less or equal to the provided value the range below the search value intersects (ie overlaps) with the

range of the target value or the range of the search value fully contains

the range of the target value

If no prefix is present the prefix eq is assumed

313 Supported Search Parameters

GET DiagnosticReport (query by Patient ID) o Patient ID parameter patientpatientidentifier

Only Ontario health card number is allowed as an ID parameter in the current release Example patientpatientidentifier=[id-system-global-base]ca-on-patient-hcn|12345678

o Patient Gender parameter gender patientgender Example patientgender=male

o Patient Date of Birth parameter patientbirthdate Example patientbirthdate=19291129

o Dates parameter issuedstart Example issuedstart=ge20160102

314 Search Example

GET [base] DiagnosticReportspatientpatientidentifier=[id-system-global-base]ca-on-patient-hcn| 1008624486amp patientgender=maleamppatientbirthdate=19291129ampissuedstart=ge20160102

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 10

4 FHIR Resources Definitions

General Overview 41

411 Supported Attributes

Only attributes described in the subsections below will be supported

412 Format

OLIS will support JSON and XML formats JSON is the preferred format

Infrastructure Resources 42

421 Resource - Base Resource Definitions

httpwwwhl7orgFHIRresourcehtml Name Card Type ValueVocab Description Comments id 01 id Unique ID set by FHIR server Logical id of this artifact meta 01 Meta Only ldquolastUpdatedrdquo element to be populated

by FHIR server Metadata about the resource

lastUpdated 01 instant This value changes each time the content of the resource changes

language 01 code Used only for Bundle and fixed to ldquoenrdquo in the current release

Language of the resource content

422 DomainResource Resource

httpwwwhl7orgFHIRdomainresourcehtml

A resource with narrative extensions and contained resources

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 11

If a resource is contained in another resource it SHALL NOT have a metaversionId or a metalastUpdated

If the resource is contained in another resource it SHALL be referred to from elsewhere in the resource

If the resource is contained in another resource it SHALL NOT contain nested Resources

If the resource is contained in another resource it SHALL NOT contain any narrative

Most resources are derived from Domain Resources - so they also can contain text contained resources extensions and data elements specific to the particular

domain of the resource

Name Card Type ValueVocab Description Comments text 01 Narrative Text summary of the resource for human

interpretation Not used in the current release

contained 0 Resource Contained inline Resources extension 0 Extension Additional Content defined by

implementations

modifierExtension

0 Extension Extensions that cannot be ignored

423 Bundle Resource

Based on httpwwwhl7orgFHIRbundlehtml

A special type of resource for collections of resources

A set of search results (type = searchset) consists of a series of zero or more entries Each entry element will contain a resource

Bundletotal may be used to return the total number of resources that match the search and that may be returned by following the next link

Name Card Type ValueVocab Description Comments type 11 code Fixed to ldquosearchsetrdquo Type of bundle total 01 unsignedI

nt The total number of matches

link 0 BackboneElement

Links related to this Bundle Optional element might be returned by a server

relation 11 string ldquoselfrdquo for the link to the this Bundle ldquonextrdquo for the link to the next page

ValueSet httpwwwianaorgassignmentslink-relationslink-relationsxhtml

url 11 uri Reference details for the link entry 0 Backbone

Element Entry in the bundle - will have a resource

or information

fullUrl 01 uri The fullUrl element must be present when a resource is present and not present otherwise

Absolute URL for resource (server address or UUIDOID)

resource 01 Resource A resource in the bundle

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 12

424 OperationOutcome Resource

Based on httphl7orgfhiroperationoutcomehtml

Operation Outcomes are sets of error warning and information messages that provide detailed information about the outcome of some attempted system

operation They are provided as a direct system response or component of one where they provide information about the outcome of the operation

OperationOutcomes are used in the following circumstances

When an RESTful operation fails

As the response on a validation operation to provide information about the outcomes

As part of a message response usually when the message has not been processed correctly

This resource is not used for reporting clinical or workflow issues associated with a proposed or ongoing action The resource is not designed to be persisted or

referenced from other parts of the workflow

Name Card

Type ValueVocab Description Comments

issue 1 BackboneElement

A single issue associated with the action

severity 11 code ValueSethttphl7orgfhirvalueset-issue-severityhtml

fatal | error | warning | information

code 11 ValueSethttphl7orgfhirvalueset-issue-typehtml

Error or warning code

details 01 CodeableConcept

ValueSet httphl7orgfhirvalueset-operation-outcomehtml

Additional details about the error

diagnostics 01 string Additional diagnostic information about the issue

location 0 string XPath of element(s) related to issue

425 Using Operation Outcome Resources

On the RESTful interface operation outcome resources are only relevant when a level of computable detail is required that is more granular than that provided by

the HTTP response codes This granularity could include

more detail about the location of an issue

the ability to identify multiple distinct issues

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 13

provision of finer error codes that connect to known business failure states

426 Reporting Errors in the HTTP Headers

Server may also need to report errors in the HTTP headers - especially query parameters when processing searches Errors are reported using a case sensitive

location that has two parts a fixed http and the header or query parameter name separated by a Some examples

Location Description

httpnameexact A reference to the search parameter name with the modifier exact

httpAuthorization A reference to the Authorization header - perhaps to indicate that it is missing and some form of authentication is required

427 OperationOutcome Example - Search

resourceType OperationOutcome

id OperationOutcome1234

issue [

severity fatal

code code-invalid

details

text The name parameter has the modifier exact which is not supported by this server

location [

httpnameexact

]

]

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 14

FHIR Resources 43

DiagnosticReport

PractitionerOrdering Practitioner

Extension ResultCopiestoPractitioners

PatientDiagnosticReportSubject

Organization

PerformingLab

DiagnosticReport

OrganizationReportingLab

ObservationDiagnosticReportResult

SpecimenDiagnosticReportSpecimen

ProcedureRequestDiagnosticReportProcedureRequest

PractitionerAttendingAdmitting

OrganizationExtension

SpecimenCollectorCenter

OrganizationExtension

DestinationLabOrderPlacer

Encounter

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 15

431 Diagnostic Report Profile

ca-on-Diagnostic-DiagnosticReport based on Diagnostic Report profile httphl7orgfhirdiagnosticreporthtml

Name Card Type ValueVocab Description Comments identifier 11 Identifier Identifier assigned by the sending

organization - this is an identifier assigned outside FHIR

This field contains an identifier for the entire order The Placer Group Number is conceptually equivalent to a requisition number assigned to all test requests in an order by an organization (ORC4)

system 11 Uri

The source of the lab reports (ORC43)

value 11 string The unique identifier of the lab report record (ORC41)

status 11 code Value set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

code CodeableConcept

coding 11 coding Fixed code ldquo11502-2rdquo Code defined by a LOINC text 11 string Fixed value ldquoLaboratory Reportrdquo Plain text representation of the concept

Subject (patient)

11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

issued 01 instant dateTime when test request has been issued An instant in time - known at least to the second and always includes a time zone This field will be populated by system (OBR22)

performer 01 Reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

The individual responsible for reporting test result Can be reporting laboratory or reporting practitioner

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 16

Name Card Type ValueVocab Description Comments reference 11 string A reference to a location at which the

other resource is found

request 1 Reference Contained ca-on-Diagnostic-ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

specimen 01 Reference Contained ca-on-Diagnostic-Specimen (Specimen) resource

Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

Result 1 Reference Contained ca-on-Diagnostic-Observation (Observation) resource

List of all the observation associated with the test request (OBX)

reference 11 string A reference to a location at which the other resource is found

codedDiagnosi

s

01 CodeableCon

cept

Value Set ICD10 Diagnosis information

coding 11 coding A reference to a location at which the other resource is found

text 11 string A reference to a location at which the other resource is found

432 Procedure Request Profile

ca-on-Diagnostic-ProcedureRequest profile based on httphl7orgfhirprocedurerequesthtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier assigned by the ordering facility - this is an identifier assigned outside FHIR Must contain a value assigned by the order-placing organization that uniquely identifies this test request among all test requests in OLIS (OBR2)

system 11 Uri The source of test request on the lab report (OBR23)

value 11 string The unique identifier of the test request record (OBR21)

This represents the test request number from the LIS or HIS systems

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 17

Name Card Type ValueVocab Description Comments

status 11 code Value Set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

intent 11 code Value set httphl7orgfhirValueSetrequest-intent

proposal | plan | original-order | order| reflex-order (OBR11)

If OBR11 contains lsquoGrsquo populate lsquoreflex-testrsquo value otherwise fix the value to lsquoOrderrsquo

priority 11 code Value set httphl7orgfhirValueSetrequest-priority

routine | urgent | asap | stat

RequestPriority (Required) (OBR276)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Context (encounter)

11 Reference Contained ca-on-Diagnostic-Encounter (Encounter) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

occuranceDateTime

11 dateTime When testing should occur (OBR274) For routine orders populate this field with the current date

For timing-critical orders populate this field with the date and time that the specimen is to be obtained

For future-dated orders populate this field with the scheduled future date (and time if applicable) when the laboratory test is to occur

extension

01 DateTime of Transaction (ORC9) Populate this field with the

date and time of the event

that initiated the current

transaction

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 18

url 11 httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-dateTime-transaction

valueDateTime 11 dateTime

requester 11 BackboneElement

agent 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the personorganization making request to perform the test (ordering practitionerorganization OBR16)

IF Ordering Facility exists in the message (ORC21) Scenario 1 requester (OBR16) is organization populate ORC21 with the same organization information that in OBR16 field Scenario 2 requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

onBehalfOf 01 reference Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the organization agent is acting for ordering facility

Should be mapped to ordering facility (ORC21 and ORC22) where requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension CCrsquod list practitioner (OBR28) url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-cc-practitioner-list

valueReference (Practitioner)

110 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Practitioners named on an order (attending admitting ccrsquod)

reference 11 string A reference to a location at which the

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 19

other resource is found extension 01 Extension Test Request Placer ZBR2

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-test-request-placer

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Original Test Request Placer

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension Destination Laboratory ZBR8 url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-destination-laboratory

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Destination Laboratory

reference 11 string A reference to a location at which the other resource is found

note 05 Annotation comments authorString 11 string ZNT segment Indicate the organization

(or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

extension 11 Extension Source of Comment (NTE2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-source-comment

valueString

11 string

extension 11 Extension Set ID (NTE1)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 20

set-id

valueString

11 string

433 Observation Profile

ca-on-Diagnostic-Observation profile based on httphl7orgfhirobservationhtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Unique ID for the particular observation (OBR3)

system 11 uri The namespace for the identifier (OBR32) value 11 string The value that is unique (OBR31)

status 11 code Value set Observation result status (OBX11) code CodeableCo

ncept Value set LOINCSNOMED CT

Test result code (OBX3)

coding 11 coding Code defined by a terminology system (OBX31)

text 11 string Plain text representation of the concept (OBX32)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

effective 01 Clinically relevant time for observation

effectiveDateTime

01 dateTime DateTime of observation OBX141 Use this field for ancillary order only

This field must be empty when a laboratory reports a test result

issued 11 instant Indicate the date and time that the Test Result was released by the Reporting Laboratory (ZBX1)

performer (organization)

11 Reference Contained ca-on-Deagnostic-Organization (Organization) Resource or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

The individual responsible for performing the test Can be laboratory or practitioner

reference 11 string A reference to a location at which the other resource is found

value 11 Actual result

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 21

Name Card Type ValueVocab Description Comments

valueQuantity 11 Quantity (OBX2)-Only numeric test value value 11 decimal Numeric value of the test result (OBX5) unit 01 string When observation Value is a scalar value this

field describes the units of measure (OBX61)

interpretation 01 CodebaleConcept

Observation Interpretation Codes(OBX8)

coding 01 Coding Value set method 01 CodebaleCo

ncept How the observation has been done (OBX17)

text 11 string Plain text (OBX172) specimen 01 Reference Contained ca-on-Diagnostic-

Specimen (Specimen) resource Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

referenceRange 01 BackboneElement

Normal range of value associated with observation result (OBX7)

text 11 string Text based reference range in an observation

extension 01 Extension Nature of Abnormal Test (OBX10)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-nature-abnormal-test

valuecoding

11 coding Value set

extension 01 Extension Observation sub-id (OBX4)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation sort key (ZBX2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation comment (NTE-ZNT)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 22

url 11 uri httpehealthontariocaAPIfhir

StructureDefinitiondiagnosticReport-ext-observation-comment

valueAnnotation

11 annotation

authorString

11 string ZNT segment Indicate the organization (or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

434 Specimen Profile

ca-on-Diagnostic-Specimen profile based on httphl7orgfhirspecimenhtml

Name Card Type ValueVocab Description Comments

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

receivedTime 11 dateTime The time when specimen was received for processing

OBR14

request 1 Reference Contained ca-on-Diagnostic- ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

extension 11 Extension Organization that collected the specimen

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-specimen-collector-center

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Specimen Collector Center (ZBR3)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 23

Name Card Type ValueVocab Description Comments

Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

reference 11 string A reference to a location at which the other resource is found

reference 11 string A reference to a location at which the other resource is found

collected 01 Specimen collection time CollectedPeriod 11 Period

start 01 dateTime Starting specimen time OBR7 end 01 dateTime End specimen time OBR8

type 01 CodeableConcept

Kind of material that forms the specimen (Specimen Type)

OBR15

coding 01 coding Value Set from OLIS Code define by the terminology system

OBR1511

text 01 string Plain text representation of the concept

OBR1512

bodySite 01 CodeableConcept

Value Set Anatomical collection site OBR155

container 01 BackboneElement

Direct container of specimen

identifier 02 identifier Id for container OBR18 andor OBR20 Referring Lab User Specimen Identifier and Performing Lab User Specimen Identifier on Refereed ndashout orders

specimenQuantity

01 SimpleQuantity

Quantity of specimen within container

OBR37

note 01 Annotation Collectors comments text 11 string Collectors comments OBR39

extension 01 Extension Collection volume (OBR9)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-collection-volume

valueQuantity

11 Quantity

value 11 decimal Numeric value of the collection OBR91

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 24

volume unit 01 string Units of measure OBR921

435 Patient Profile

ca-on-Diagnostic-Patient profile based on httphl7orgfhirpatienthtml

Name

Card Type ValueVocab Description Comment

identifier

1 Identifier An identifier for this patient

system 11 uri [id-system-global-base]ca-on-patient-hcn

Patient Identifier Assigning Authority Namespace in which set of possible id values is unique (PID391 PID392 PID393)

Value 11 string Patient Identifier Number The portion of the identifier typically displayed to the user and which is unique within the context of the system (PID31)

extension 01 Health Card Version code (PID311) this is an extension patient identifier

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionext-identifier-hcn-version-code

valueString 11 string name

01 HumanName

use 11 code Value set httphl7orgfhirValueSetname-use

Purpose of this name Name type code PID57

Fix to the official for all cases except for anonymous For anonymous code should be lsquoanonymousrsquo

family 11 string Patient Last Name (PID51) given 02 string Patient First Name(PID52) extension 01 patient middle name (PID53)

this is an extension of given name

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode 11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name (PID55)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 25

Name

Card Type ValueVocab Description Comment

suffix 02 String Parts that come after the name (PID54)

extension 01 Patient degree designation This is an extension of suffix

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoACrdquo Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

telecom 03 Demographics Patient table Telephone Number system 01 code httphl7orgfhir

ValueSetcontact-point-system

Telecommunications form for contact point (Phone fax email pager url sms other) PID133 or PID143

Value 11 string The actual contact point details PID134-PID138 Or PID144-PID148

use 01 code httphl7orgfhirValueSetcontact-point-use

Use of contact point (Home work temp old mobile) PID132 or PID142

gender 11 code ldquomalerdquo ldquofemalerdquo ldquootherrdquo ldquounknownrdquo (httphl7orgfhirValueSetadministrative-gender)

The gender of a person used for administrative purposes (PID8)

birthDate 11 date The date of birth for the individual (PID7) Deceased[x]

01 boolean|dateTime

Indicates if the individual is deceased or not The value must be one of the choices specified below but not both System creating instance of this resource must decide which type to use at run time (PID30)

deceasedBoolean

boolean true|false

deceasedDateTime

dateTime Deceased datetime if known (PID29)

address 12 Address Demographics Patient table Address for the individual (PID11)

use 11 code ValueSet httphl7orgfhir

Address Type The use of an address

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 26

Name

Card Type ValueVocab Description Comment

ValueSetaddress-use

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

line 11 string Street lines (PID111) city 11 string Name of city town etc (PID113) state 01 string Province or territory (PID114) postalCode 01 string Postal code for area (PID115) country 11 string Country (can be ISO 3166 3 letter code) (PID116)

436 Practitioner Profile (Ordering Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent Ordering Practitioner information

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR1622

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR161

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR162 given 12 string Practitioner First Name OBR163

extension

01 Practitioner middle name this is an extension of given name

OBR164

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 5: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page ii

4314 Organization Profile (Test Request Placer) 33 4315 Organization Profile (Destination Laboratory) 34 4316 Encounter Profile 34

Data Type Notes 35 44

441 Date 35 442 DateTime 35 443 Time 36 444 URI 36

Appendix A JWT Autorisation header 37 HTTP Response Codes 37 IANA Defined HTTP Status Codes 37

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 3

1 Introduction

Summary and Scope 11

The purpose of this document is to capture solution design for Ontario Laboratories Information System (OLIS) It establishes a common understanding amongst

the stakeholder groups of the solution design needed development and implementation of the OLIS Solution The scope of this document will evolve over the

lifecycle of the project

Intended Audience 12

The intended audiences of this document are business and technical implementers who are interested in retrieving laboratory reports from OLIS The readers are

expected to have an understanding of the business and technical requirements for querying and receiving laboratory report information from the Ontario

Laboratories Information System

Background 13

OLIS is a single provincial system that allows all laboratory information on human beings in Ontario to be exchanged electronically between practitioners and

laboratory service providers and provides the Ministry of Health and Long-Term Care (MOHLTC) with program management information OLIS facilitates the

exchange of laboratory information on human beings in Ontario amongst LIS HIS EMR and other point of service systems (POS) but it is not a LIS system in its

own right and is not intended to replace existing LIS systems OLIS has an existing HL7 v2 interface used by labs to submit results and Inquiry interface used by

clinical point of service (POS) systems

Primary intension of the OLIS FHIR interface is to provide an interface that can be used by patients to access their information in OLIS (consumer interface)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 4

Reference Materials 14

Table 1 Reference Materials

Document Name Location

HL7 FHIR STU3 httphl7orgfhir

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 5

2 How to Implement HL7 FHIR

Content Types and Encodings 21

The formal MIME-type for FHIR resources is applicationjson+fhir or applicationxml+fhir The correct mime type SHALL be used by clients and servers

JSON (preferred) applicationjson+fhir

XML (optional) applicationxml+fhir

FHIR uses UTF-8 for all request and response bodies Since the HTTP specification defines a default character encoding of ISO-8859-1 requests and responses

SHALL explicitly set the character encoding to UTF-8 using the charset parameter of the MIME-type in the Content-Type header Requests MAY also specify

this charset parameter in the Accept header andor use the Accept-Charset header

Summary of all FHIR Request Interactions

The table below shows the allowed transactions on FHIR resources and their corresponding HTTP operations

Table 2 OLIS FHIR HTTP Operations

Resource Transaction HTTP Verb

DiagnosticReport Search GET

DiagnosticReport Read GET

Special Case Missing data

In some cases implementers may find that they do not have appropriate data for an element with minimum cardinality = 1 In this case the element must be

present but unless the resource or a profile on it has made the actual value of the primitive data type mandatory it is possible to provide an extension that explains

why the primitive value is not present

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 6

XML

lturigt

ltextension url=httphl7orgfhirStructureDefinitiondata-absent-reasongt

ltvalueCode=unknowngt

ltextensiongt

lturigt

JSON

_uri

extension [

url httphl7orgfhirStructureDefinitiondata-absent-reason

valueCode unknown

]

In this example instead of a value a data missing code is provided (httpswwwhl7orgfhirextension-data-absent-reasonhtml) Note that it is not required that

this particular extension is used This extension is not a modifier extension because the primitive data type has no value

It is not valid to create a fictional piece of data for the primitive value and then to add an extension indicating that the data has been constructed to meet the data

rules This would be both a bad idea and also a modifier extension which is not allowed on data types

Naming Convention

The base URL for OLIS FHIR interface will be referred to as ldquo[base]rdquo in the sections and examples below Please note that base URL might change over time

The base for Naming System (namespace of identifiers and code system of local terminologies) is httpsehealthontariocaAPIFHIRNamingSystem For

globalshareable identifiers (eg Ontario health care number Ontario Physician License etc) this might be replaced with httphl7orgfhirNamingSystemca-

on-license-physician in the future when HL7 FHIR Naming System registry is available The base for global identifier namespaces will be referred to as [id-

system-global-base] in the sections and examples below The base for local identifier namespaces (eg placer group number order number etc) will be referred

to as ldquo[id-system-local-base]rdquo in the sections and examples below The base for local code systems (eg test request code) will be referred to as ldquo[code-system-local-

base]rdquo in the sections and examples below

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 7

Variable Value

[base] httpswsgatewayprodehealthontariocaAPIFHIRLaboratoryv1Diagnostic

Report

[base-structure] httpsehealthontariocaAPIFHIRStructureDefinition

[id-system-global-base] httpsehealthontariocaAPIFHIRNamingSystem

[id-system-local-base] httpsehealthontariocaAPIFHIRNamingSystem

[code-system-local-base] httpsehealthontariocaAPIFHIRNamingSystem

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 8

3 Supported Operations

Search Laboratory Report 31

This interaction searches a set of resources based on some filter criteria The interaction can be performed by several different HTTP commands

GET [base][type][parameters]amp_format=[mime-type]

This searches all resources of a particular type using the criteria represented in the parameters

All these search interactions take a series of parameters that are a series of name=value pairs encoded in the URL (See W3C HTML forms)

If the search fails (cannot be executed not that there is no matches) the return value is a status code 4xx or 5xx with an OperationOutcome If the search succeeds

the return content is a Bundle with type = searchset containing the results of the search as a list of resources in a defined order The result list can be long so server

will use paging (adapted from RFC 5005 (Feed Paging and Archiving) for breaking the list into pages if appropriate (see Paging section below) The server may also

return an OperationOutcome resource with additional information about the search

311 Search Parameter Types

Each search parameter is defined by a type that specifies how the search parameter behaves These are the defined parameter types

number Search parameter SHALL be a number (a whole number or a decimal)

date Search parameter is on a datetime The date format is the standard XML format

string Search parameter is a simple string like a name part Search is case-insensitive and accent-insensitive May match just the start of a string String

parameters may contain spaces

token Search parameter on a coded element or identifier May be used to search through the text displayname code and codecodesystem (for codes) and label

system and key (for identifier) Its value is either a string or a pair of namespace and value separated by a | depending on the modifier used

312 Prefixes

For the ordered parameter types of number date and quantity a prefix to the parameter value may be used to control the nature of the matching To avoid URL

escaping and visual confusion the following prefixes are used

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 9

eq the value for the parameter in the resource is equal to the provided value the range of the search value fully contains the range of the target value

gt the value for the parameter in the resource is greater than the provided value the range above the search value intersects (ie overlaps) with the

range of the target value

lt the value for the parameter in the resource is less than the provided value the range below the search value intersects (ie overlaps) with the

range of the target value

ge the value for the parameter in the resource is greater or equal to the provided value the range above the search value intersects (ie overlaps) with the

range of the target value or the range of the search value fully contains

the range of the target value

le the value for the parameter in the resource is less or equal to the provided value the range below the search value intersects (ie overlaps) with the

range of the target value or the range of the search value fully contains

the range of the target value

If no prefix is present the prefix eq is assumed

313 Supported Search Parameters

GET DiagnosticReport (query by Patient ID) o Patient ID parameter patientpatientidentifier

Only Ontario health card number is allowed as an ID parameter in the current release Example patientpatientidentifier=[id-system-global-base]ca-on-patient-hcn|12345678

o Patient Gender parameter gender patientgender Example patientgender=male

o Patient Date of Birth parameter patientbirthdate Example patientbirthdate=19291129

o Dates parameter issuedstart Example issuedstart=ge20160102

314 Search Example

GET [base] DiagnosticReportspatientpatientidentifier=[id-system-global-base]ca-on-patient-hcn| 1008624486amp patientgender=maleamppatientbirthdate=19291129ampissuedstart=ge20160102

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 10

4 FHIR Resources Definitions

General Overview 41

411 Supported Attributes

Only attributes described in the subsections below will be supported

412 Format

OLIS will support JSON and XML formats JSON is the preferred format

Infrastructure Resources 42

421 Resource - Base Resource Definitions

httpwwwhl7orgFHIRresourcehtml Name Card Type ValueVocab Description Comments id 01 id Unique ID set by FHIR server Logical id of this artifact meta 01 Meta Only ldquolastUpdatedrdquo element to be populated

by FHIR server Metadata about the resource

lastUpdated 01 instant This value changes each time the content of the resource changes

language 01 code Used only for Bundle and fixed to ldquoenrdquo in the current release

Language of the resource content

422 DomainResource Resource

httpwwwhl7orgFHIRdomainresourcehtml

A resource with narrative extensions and contained resources

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 11

If a resource is contained in another resource it SHALL NOT have a metaversionId or a metalastUpdated

If the resource is contained in another resource it SHALL be referred to from elsewhere in the resource

If the resource is contained in another resource it SHALL NOT contain nested Resources

If the resource is contained in another resource it SHALL NOT contain any narrative

Most resources are derived from Domain Resources - so they also can contain text contained resources extensions and data elements specific to the particular

domain of the resource

Name Card Type ValueVocab Description Comments text 01 Narrative Text summary of the resource for human

interpretation Not used in the current release

contained 0 Resource Contained inline Resources extension 0 Extension Additional Content defined by

implementations

modifierExtension

0 Extension Extensions that cannot be ignored

423 Bundle Resource

Based on httpwwwhl7orgFHIRbundlehtml

A special type of resource for collections of resources

A set of search results (type = searchset) consists of a series of zero or more entries Each entry element will contain a resource

Bundletotal may be used to return the total number of resources that match the search and that may be returned by following the next link

Name Card Type ValueVocab Description Comments type 11 code Fixed to ldquosearchsetrdquo Type of bundle total 01 unsignedI

nt The total number of matches

link 0 BackboneElement

Links related to this Bundle Optional element might be returned by a server

relation 11 string ldquoselfrdquo for the link to the this Bundle ldquonextrdquo for the link to the next page

ValueSet httpwwwianaorgassignmentslink-relationslink-relationsxhtml

url 11 uri Reference details for the link entry 0 Backbone

Element Entry in the bundle - will have a resource

or information

fullUrl 01 uri The fullUrl element must be present when a resource is present and not present otherwise

Absolute URL for resource (server address or UUIDOID)

resource 01 Resource A resource in the bundle

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 12

424 OperationOutcome Resource

Based on httphl7orgfhiroperationoutcomehtml

Operation Outcomes are sets of error warning and information messages that provide detailed information about the outcome of some attempted system

operation They are provided as a direct system response or component of one where they provide information about the outcome of the operation

OperationOutcomes are used in the following circumstances

When an RESTful operation fails

As the response on a validation operation to provide information about the outcomes

As part of a message response usually when the message has not been processed correctly

This resource is not used for reporting clinical or workflow issues associated with a proposed or ongoing action The resource is not designed to be persisted or

referenced from other parts of the workflow

Name Card

Type ValueVocab Description Comments

issue 1 BackboneElement

A single issue associated with the action

severity 11 code ValueSethttphl7orgfhirvalueset-issue-severityhtml

fatal | error | warning | information

code 11 ValueSethttphl7orgfhirvalueset-issue-typehtml

Error or warning code

details 01 CodeableConcept

ValueSet httphl7orgfhirvalueset-operation-outcomehtml

Additional details about the error

diagnostics 01 string Additional diagnostic information about the issue

location 0 string XPath of element(s) related to issue

425 Using Operation Outcome Resources

On the RESTful interface operation outcome resources are only relevant when a level of computable detail is required that is more granular than that provided by

the HTTP response codes This granularity could include

more detail about the location of an issue

the ability to identify multiple distinct issues

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 13

provision of finer error codes that connect to known business failure states

426 Reporting Errors in the HTTP Headers

Server may also need to report errors in the HTTP headers - especially query parameters when processing searches Errors are reported using a case sensitive

location that has two parts a fixed http and the header or query parameter name separated by a Some examples

Location Description

httpnameexact A reference to the search parameter name with the modifier exact

httpAuthorization A reference to the Authorization header - perhaps to indicate that it is missing and some form of authentication is required

427 OperationOutcome Example - Search

resourceType OperationOutcome

id OperationOutcome1234

issue [

severity fatal

code code-invalid

details

text The name parameter has the modifier exact which is not supported by this server

location [

httpnameexact

]

]

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 14

FHIR Resources 43

DiagnosticReport

PractitionerOrdering Practitioner

Extension ResultCopiestoPractitioners

PatientDiagnosticReportSubject

Organization

PerformingLab

DiagnosticReport

OrganizationReportingLab

ObservationDiagnosticReportResult

SpecimenDiagnosticReportSpecimen

ProcedureRequestDiagnosticReportProcedureRequest

PractitionerAttendingAdmitting

OrganizationExtension

SpecimenCollectorCenter

OrganizationExtension

DestinationLabOrderPlacer

Encounter

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 15

431 Diagnostic Report Profile

ca-on-Diagnostic-DiagnosticReport based on Diagnostic Report profile httphl7orgfhirdiagnosticreporthtml

Name Card Type ValueVocab Description Comments identifier 11 Identifier Identifier assigned by the sending

organization - this is an identifier assigned outside FHIR

This field contains an identifier for the entire order The Placer Group Number is conceptually equivalent to a requisition number assigned to all test requests in an order by an organization (ORC4)

system 11 Uri

The source of the lab reports (ORC43)

value 11 string The unique identifier of the lab report record (ORC41)

status 11 code Value set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

code CodeableConcept

coding 11 coding Fixed code ldquo11502-2rdquo Code defined by a LOINC text 11 string Fixed value ldquoLaboratory Reportrdquo Plain text representation of the concept

Subject (patient)

11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

issued 01 instant dateTime when test request has been issued An instant in time - known at least to the second and always includes a time zone This field will be populated by system (OBR22)

performer 01 Reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

The individual responsible for reporting test result Can be reporting laboratory or reporting practitioner

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 16

Name Card Type ValueVocab Description Comments reference 11 string A reference to a location at which the

other resource is found

request 1 Reference Contained ca-on-Diagnostic-ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

specimen 01 Reference Contained ca-on-Diagnostic-Specimen (Specimen) resource

Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

Result 1 Reference Contained ca-on-Diagnostic-Observation (Observation) resource

List of all the observation associated with the test request (OBX)

reference 11 string A reference to a location at which the other resource is found

codedDiagnosi

s

01 CodeableCon

cept

Value Set ICD10 Diagnosis information

coding 11 coding A reference to a location at which the other resource is found

text 11 string A reference to a location at which the other resource is found

432 Procedure Request Profile

ca-on-Diagnostic-ProcedureRequest profile based on httphl7orgfhirprocedurerequesthtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier assigned by the ordering facility - this is an identifier assigned outside FHIR Must contain a value assigned by the order-placing organization that uniquely identifies this test request among all test requests in OLIS (OBR2)

system 11 Uri The source of test request on the lab report (OBR23)

value 11 string The unique identifier of the test request record (OBR21)

This represents the test request number from the LIS or HIS systems

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 17

Name Card Type ValueVocab Description Comments

status 11 code Value Set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

intent 11 code Value set httphl7orgfhirValueSetrequest-intent

proposal | plan | original-order | order| reflex-order (OBR11)

If OBR11 contains lsquoGrsquo populate lsquoreflex-testrsquo value otherwise fix the value to lsquoOrderrsquo

priority 11 code Value set httphl7orgfhirValueSetrequest-priority

routine | urgent | asap | stat

RequestPriority (Required) (OBR276)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Context (encounter)

11 Reference Contained ca-on-Diagnostic-Encounter (Encounter) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

occuranceDateTime

11 dateTime When testing should occur (OBR274) For routine orders populate this field with the current date

For timing-critical orders populate this field with the date and time that the specimen is to be obtained

For future-dated orders populate this field with the scheduled future date (and time if applicable) when the laboratory test is to occur

extension

01 DateTime of Transaction (ORC9) Populate this field with the

date and time of the event

that initiated the current

transaction

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 18

url 11 httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-dateTime-transaction

valueDateTime 11 dateTime

requester 11 BackboneElement

agent 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the personorganization making request to perform the test (ordering practitionerorganization OBR16)

IF Ordering Facility exists in the message (ORC21) Scenario 1 requester (OBR16) is organization populate ORC21 with the same organization information that in OBR16 field Scenario 2 requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

onBehalfOf 01 reference Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the organization agent is acting for ordering facility

Should be mapped to ordering facility (ORC21 and ORC22) where requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension CCrsquod list practitioner (OBR28) url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-cc-practitioner-list

valueReference (Practitioner)

110 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Practitioners named on an order (attending admitting ccrsquod)

reference 11 string A reference to a location at which the

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 19

other resource is found extension 01 Extension Test Request Placer ZBR2

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-test-request-placer

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Original Test Request Placer

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension Destination Laboratory ZBR8 url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-destination-laboratory

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Destination Laboratory

reference 11 string A reference to a location at which the other resource is found

note 05 Annotation comments authorString 11 string ZNT segment Indicate the organization

(or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

extension 11 Extension Source of Comment (NTE2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-source-comment

valueString

11 string

extension 11 Extension Set ID (NTE1)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 20

set-id

valueString

11 string

433 Observation Profile

ca-on-Diagnostic-Observation profile based on httphl7orgfhirobservationhtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Unique ID for the particular observation (OBR3)

system 11 uri The namespace for the identifier (OBR32) value 11 string The value that is unique (OBR31)

status 11 code Value set Observation result status (OBX11) code CodeableCo

ncept Value set LOINCSNOMED CT

Test result code (OBX3)

coding 11 coding Code defined by a terminology system (OBX31)

text 11 string Plain text representation of the concept (OBX32)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

effective 01 Clinically relevant time for observation

effectiveDateTime

01 dateTime DateTime of observation OBX141 Use this field for ancillary order only

This field must be empty when a laboratory reports a test result

issued 11 instant Indicate the date and time that the Test Result was released by the Reporting Laboratory (ZBX1)

performer (organization)

11 Reference Contained ca-on-Deagnostic-Organization (Organization) Resource or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

The individual responsible for performing the test Can be laboratory or practitioner

reference 11 string A reference to a location at which the other resource is found

value 11 Actual result

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 21

Name Card Type ValueVocab Description Comments

valueQuantity 11 Quantity (OBX2)-Only numeric test value value 11 decimal Numeric value of the test result (OBX5) unit 01 string When observation Value is a scalar value this

field describes the units of measure (OBX61)

interpretation 01 CodebaleConcept

Observation Interpretation Codes(OBX8)

coding 01 Coding Value set method 01 CodebaleCo

ncept How the observation has been done (OBX17)

text 11 string Plain text (OBX172) specimen 01 Reference Contained ca-on-Diagnostic-

Specimen (Specimen) resource Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

referenceRange 01 BackboneElement

Normal range of value associated with observation result (OBX7)

text 11 string Text based reference range in an observation

extension 01 Extension Nature of Abnormal Test (OBX10)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-nature-abnormal-test

valuecoding

11 coding Value set

extension 01 Extension Observation sub-id (OBX4)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation sort key (ZBX2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation comment (NTE-ZNT)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 22

url 11 uri httpehealthontariocaAPIfhir

StructureDefinitiondiagnosticReport-ext-observation-comment

valueAnnotation

11 annotation

authorString

11 string ZNT segment Indicate the organization (or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

434 Specimen Profile

ca-on-Diagnostic-Specimen profile based on httphl7orgfhirspecimenhtml

Name Card Type ValueVocab Description Comments

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

receivedTime 11 dateTime The time when specimen was received for processing

OBR14

request 1 Reference Contained ca-on-Diagnostic- ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

extension 11 Extension Organization that collected the specimen

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-specimen-collector-center

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Specimen Collector Center (ZBR3)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 23

Name Card Type ValueVocab Description Comments

Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

reference 11 string A reference to a location at which the other resource is found

reference 11 string A reference to a location at which the other resource is found

collected 01 Specimen collection time CollectedPeriod 11 Period

start 01 dateTime Starting specimen time OBR7 end 01 dateTime End specimen time OBR8

type 01 CodeableConcept

Kind of material that forms the specimen (Specimen Type)

OBR15

coding 01 coding Value Set from OLIS Code define by the terminology system

OBR1511

text 01 string Plain text representation of the concept

OBR1512

bodySite 01 CodeableConcept

Value Set Anatomical collection site OBR155

container 01 BackboneElement

Direct container of specimen

identifier 02 identifier Id for container OBR18 andor OBR20 Referring Lab User Specimen Identifier and Performing Lab User Specimen Identifier on Refereed ndashout orders

specimenQuantity

01 SimpleQuantity

Quantity of specimen within container

OBR37

note 01 Annotation Collectors comments text 11 string Collectors comments OBR39

extension 01 Extension Collection volume (OBR9)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-collection-volume

valueQuantity

11 Quantity

value 11 decimal Numeric value of the collection OBR91

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 24

volume unit 01 string Units of measure OBR921

435 Patient Profile

ca-on-Diagnostic-Patient profile based on httphl7orgfhirpatienthtml

Name

Card Type ValueVocab Description Comment

identifier

1 Identifier An identifier for this patient

system 11 uri [id-system-global-base]ca-on-patient-hcn

Patient Identifier Assigning Authority Namespace in which set of possible id values is unique (PID391 PID392 PID393)

Value 11 string Patient Identifier Number The portion of the identifier typically displayed to the user and which is unique within the context of the system (PID31)

extension 01 Health Card Version code (PID311) this is an extension patient identifier

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionext-identifier-hcn-version-code

valueString 11 string name

01 HumanName

use 11 code Value set httphl7orgfhirValueSetname-use

Purpose of this name Name type code PID57

Fix to the official for all cases except for anonymous For anonymous code should be lsquoanonymousrsquo

family 11 string Patient Last Name (PID51) given 02 string Patient First Name(PID52) extension 01 patient middle name (PID53)

this is an extension of given name

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode 11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name (PID55)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 25

Name

Card Type ValueVocab Description Comment

suffix 02 String Parts that come after the name (PID54)

extension 01 Patient degree designation This is an extension of suffix

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoACrdquo Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

telecom 03 Demographics Patient table Telephone Number system 01 code httphl7orgfhir

ValueSetcontact-point-system

Telecommunications form for contact point (Phone fax email pager url sms other) PID133 or PID143

Value 11 string The actual contact point details PID134-PID138 Or PID144-PID148

use 01 code httphl7orgfhirValueSetcontact-point-use

Use of contact point (Home work temp old mobile) PID132 or PID142

gender 11 code ldquomalerdquo ldquofemalerdquo ldquootherrdquo ldquounknownrdquo (httphl7orgfhirValueSetadministrative-gender)

The gender of a person used for administrative purposes (PID8)

birthDate 11 date The date of birth for the individual (PID7) Deceased[x]

01 boolean|dateTime

Indicates if the individual is deceased or not The value must be one of the choices specified below but not both System creating instance of this resource must decide which type to use at run time (PID30)

deceasedBoolean

boolean true|false

deceasedDateTime

dateTime Deceased datetime if known (PID29)

address 12 Address Demographics Patient table Address for the individual (PID11)

use 11 code ValueSet httphl7orgfhir

Address Type The use of an address

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 26

Name

Card Type ValueVocab Description Comment

ValueSetaddress-use

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

line 11 string Street lines (PID111) city 11 string Name of city town etc (PID113) state 01 string Province or territory (PID114) postalCode 01 string Postal code for area (PID115) country 11 string Country (can be ISO 3166 3 letter code) (PID116)

436 Practitioner Profile (Ordering Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent Ordering Practitioner information

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR1622

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR161

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR162 given 12 string Practitioner First Name OBR163

extension

01 Practitioner middle name this is an extension of given name

OBR164

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 6: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 3

1 Introduction

Summary and Scope 11

The purpose of this document is to capture solution design for Ontario Laboratories Information System (OLIS) It establishes a common understanding amongst

the stakeholder groups of the solution design needed development and implementation of the OLIS Solution The scope of this document will evolve over the

lifecycle of the project

Intended Audience 12

The intended audiences of this document are business and technical implementers who are interested in retrieving laboratory reports from OLIS The readers are

expected to have an understanding of the business and technical requirements for querying and receiving laboratory report information from the Ontario

Laboratories Information System

Background 13

OLIS is a single provincial system that allows all laboratory information on human beings in Ontario to be exchanged electronically between practitioners and

laboratory service providers and provides the Ministry of Health and Long-Term Care (MOHLTC) with program management information OLIS facilitates the

exchange of laboratory information on human beings in Ontario amongst LIS HIS EMR and other point of service systems (POS) but it is not a LIS system in its

own right and is not intended to replace existing LIS systems OLIS has an existing HL7 v2 interface used by labs to submit results and Inquiry interface used by

clinical point of service (POS) systems

Primary intension of the OLIS FHIR interface is to provide an interface that can be used by patients to access their information in OLIS (consumer interface)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 4

Reference Materials 14

Table 1 Reference Materials

Document Name Location

HL7 FHIR STU3 httphl7orgfhir

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 5

2 How to Implement HL7 FHIR

Content Types and Encodings 21

The formal MIME-type for FHIR resources is applicationjson+fhir or applicationxml+fhir The correct mime type SHALL be used by clients and servers

JSON (preferred) applicationjson+fhir

XML (optional) applicationxml+fhir

FHIR uses UTF-8 for all request and response bodies Since the HTTP specification defines a default character encoding of ISO-8859-1 requests and responses

SHALL explicitly set the character encoding to UTF-8 using the charset parameter of the MIME-type in the Content-Type header Requests MAY also specify

this charset parameter in the Accept header andor use the Accept-Charset header

Summary of all FHIR Request Interactions

The table below shows the allowed transactions on FHIR resources and their corresponding HTTP operations

Table 2 OLIS FHIR HTTP Operations

Resource Transaction HTTP Verb

DiagnosticReport Search GET

DiagnosticReport Read GET

Special Case Missing data

In some cases implementers may find that they do not have appropriate data for an element with minimum cardinality = 1 In this case the element must be

present but unless the resource or a profile on it has made the actual value of the primitive data type mandatory it is possible to provide an extension that explains

why the primitive value is not present

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 6

XML

lturigt

ltextension url=httphl7orgfhirStructureDefinitiondata-absent-reasongt

ltvalueCode=unknowngt

ltextensiongt

lturigt

JSON

_uri

extension [

url httphl7orgfhirStructureDefinitiondata-absent-reason

valueCode unknown

]

In this example instead of a value a data missing code is provided (httpswwwhl7orgfhirextension-data-absent-reasonhtml) Note that it is not required that

this particular extension is used This extension is not a modifier extension because the primitive data type has no value

It is not valid to create a fictional piece of data for the primitive value and then to add an extension indicating that the data has been constructed to meet the data

rules This would be both a bad idea and also a modifier extension which is not allowed on data types

Naming Convention

The base URL for OLIS FHIR interface will be referred to as ldquo[base]rdquo in the sections and examples below Please note that base URL might change over time

The base for Naming System (namespace of identifiers and code system of local terminologies) is httpsehealthontariocaAPIFHIRNamingSystem For

globalshareable identifiers (eg Ontario health care number Ontario Physician License etc) this might be replaced with httphl7orgfhirNamingSystemca-

on-license-physician in the future when HL7 FHIR Naming System registry is available The base for global identifier namespaces will be referred to as [id-

system-global-base] in the sections and examples below The base for local identifier namespaces (eg placer group number order number etc) will be referred

to as ldquo[id-system-local-base]rdquo in the sections and examples below The base for local code systems (eg test request code) will be referred to as ldquo[code-system-local-

base]rdquo in the sections and examples below

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 7

Variable Value

[base] httpswsgatewayprodehealthontariocaAPIFHIRLaboratoryv1Diagnostic

Report

[base-structure] httpsehealthontariocaAPIFHIRStructureDefinition

[id-system-global-base] httpsehealthontariocaAPIFHIRNamingSystem

[id-system-local-base] httpsehealthontariocaAPIFHIRNamingSystem

[code-system-local-base] httpsehealthontariocaAPIFHIRNamingSystem

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 8

3 Supported Operations

Search Laboratory Report 31

This interaction searches a set of resources based on some filter criteria The interaction can be performed by several different HTTP commands

GET [base][type][parameters]amp_format=[mime-type]

This searches all resources of a particular type using the criteria represented in the parameters

All these search interactions take a series of parameters that are a series of name=value pairs encoded in the URL (See W3C HTML forms)

If the search fails (cannot be executed not that there is no matches) the return value is a status code 4xx or 5xx with an OperationOutcome If the search succeeds

the return content is a Bundle with type = searchset containing the results of the search as a list of resources in a defined order The result list can be long so server

will use paging (adapted from RFC 5005 (Feed Paging and Archiving) for breaking the list into pages if appropriate (see Paging section below) The server may also

return an OperationOutcome resource with additional information about the search

311 Search Parameter Types

Each search parameter is defined by a type that specifies how the search parameter behaves These are the defined parameter types

number Search parameter SHALL be a number (a whole number or a decimal)

date Search parameter is on a datetime The date format is the standard XML format

string Search parameter is a simple string like a name part Search is case-insensitive and accent-insensitive May match just the start of a string String

parameters may contain spaces

token Search parameter on a coded element or identifier May be used to search through the text displayname code and codecodesystem (for codes) and label

system and key (for identifier) Its value is either a string or a pair of namespace and value separated by a | depending on the modifier used

312 Prefixes

For the ordered parameter types of number date and quantity a prefix to the parameter value may be used to control the nature of the matching To avoid URL

escaping and visual confusion the following prefixes are used

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 9

eq the value for the parameter in the resource is equal to the provided value the range of the search value fully contains the range of the target value

gt the value for the parameter in the resource is greater than the provided value the range above the search value intersects (ie overlaps) with the

range of the target value

lt the value for the parameter in the resource is less than the provided value the range below the search value intersects (ie overlaps) with the

range of the target value

ge the value for the parameter in the resource is greater or equal to the provided value the range above the search value intersects (ie overlaps) with the

range of the target value or the range of the search value fully contains

the range of the target value

le the value for the parameter in the resource is less or equal to the provided value the range below the search value intersects (ie overlaps) with the

range of the target value or the range of the search value fully contains

the range of the target value

If no prefix is present the prefix eq is assumed

313 Supported Search Parameters

GET DiagnosticReport (query by Patient ID) o Patient ID parameter patientpatientidentifier

Only Ontario health card number is allowed as an ID parameter in the current release Example patientpatientidentifier=[id-system-global-base]ca-on-patient-hcn|12345678

o Patient Gender parameter gender patientgender Example patientgender=male

o Patient Date of Birth parameter patientbirthdate Example patientbirthdate=19291129

o Dates parameter issuedstart Example issuedstart=ge20160102

314 Search Example

GET [base] DiagnosticReportspatientpatientidentifier=[id-system-global-base]ca-on-patient-hcn| 1008624486amp patientgender=maleamppatientbirthdate=19291129ampissuedstart=ge20160102

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 10

4 FHIR Resources Definitions

General Overview 41

411 Supported Attributes

Only attributes described in the subsections below will be supported

412 Format

OLIS will support JSON and XML formats JSON is the preferred format

Infrastructure Resources 42

421 Resource - Base Resource Definitions

httpwwwhl7orgFHIRresourcehtml Name Card Type ValueVocab Description Comments id 01 id Unique ID set by FHIR server Logical id of this artifact meta 01 Meta Only ldquolastUpdatedrdquo element to be populated

by FHIR server Metadata about the resource

lastUpdated 01 instant This value changes each time the content of the resource changes

language 01 code Used only for Bundle and fixed to ldquoenrdquo in the current release

Language of the resource content

422 DomainResource Resource

httpwwwhl7orgFHIRdomainresourcehtml

A resource with narrative extensions and contained resources

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 11

If a resource is contained in another resource it SHALL NOT have a metaversionId or a metalastUpdated

If the resource is contained in another resource it SHALL be referred to from elsewhere in the resource

If the resource is contained in another resource it SHALL NOT contain nested Resources

If the resource is contained in another resource it SHALL NOT contain any narrative

Most resources are derived from Domain Resources - so they also can contain text contained resources extensions and data elements specific to the particular

domain of the resource

Name Card Type ValueVocab Description Comments text 01 Narrative Text summary of the resource for human

interpretation Not used in the current release

contained 0 Resource Contained inline Resources extension 0 Extension Additional Content defined by

implementations

modifierExtension

0 Extension Extensions that cannot be ignored

423 Bundle Resource

Based on httpwwwhl7orgFHIRbundlehtml

A special type of resource for collections of resources

A set of search results (type = searchset) consists of a series of zero or more entries Each entry element will contain a resource

Bundletotal may be used to return the total number of resources that match the search and that may be returned by following the next link

Name Card Type ValueVocab Description Comments type 11 code Fixed to ldquosearchsetrdquo Type of bundle total 01 unsignedI

nt The total number of matches

link 0 BackboneElement

Links related to this Bundle Optional element might be returned by a server

relation 11 string ldquoselfrdquo for the link to the this Bundle ldquonextrdquo for the link to the next page

ValueSet httpwwwianaorgassignmentslink-relationslink-relationsxhtml

url 11 uri Reference details for the link entry 0 Backbone

Element Entry in the bundle - will have a resource

or information

fullUrl 01 uri The fullUrl element must be present when a resource is present and not present otherwise

Absolute URL for resource (server address or UUIDOID)

resource 01 Resource A resource in the bundle

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 12

424 OperationOutcome Resource

Based on httphl7orgfhiroperationoutcomehtml

Operation Outcomes are sets of error warning and information messages that provide detailed information about the outcome of some attempted system

operation They are provided as a direct system response or component of one where they provide information about the outcome of the operation

OperationOutcomes are used in the following circumstances

When an RESTful operation fails

As the response on a validation operation to provide information about the outcomes

As part of a message response usually when the message has not been processed correctly

This resource is not used for reporting clinical or workflow issues associated with a proposed or ongoing action The resource is not designed to be persisted or

referenced from other parts of the workflow

Name Card

Type ValueVocab Description Comments

issue 1 BackboneElement

A single issue associated with the action

severity 11 code ValueSethttphl7orgfhirvalueset-issue-severityhtml

fatal | error | warning | information

code 11 ValueSethttphl7orgfhirvalueset-issue-typehtml

Error or warning code

details 01 CodeableConcept

ValueSet httphl7orgfhirvalueset-operation-outcomehtml

Additional details about the error

diagnostics 01 string Additional diagnostic information about the issue

location 0 string XPath of element(s) related to issue

425 Using Operation Outcome Resources

On the RESTful interface operation outcome resources are only relevant when a level of computable detail is required that is more granular than that provided by

the HTTP response codes This granularity could include

more detail about the location of an issue

the ability to identify multiple distinct issues

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 13

provision of finer error codes that connect to known business failure states

426 Reporting Errors in the HTTP Headers

Server may also need to report errors in the HTTP headers - especially query parameters when processing searches Errors are reported using a case sensitive

location that has two parts a fixed http and the header or query parameter name separated by a Some examples

Location Description

httpnameexact A reference to the search parameter name with the modifier exact

httpAuthorization A reference to the Authorization header - perhaps to indicate that it is missing and some form of authentication is required

427 OperationOutcome Example - Search

resourceType OperationOutcome

id OperationOutcome1234

issue [

severity fatal

code code-invalid

details

text The name parameter has the modifier exact which is not supported by this server

location [

httpnameexact

]

]

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 14

FHIR Resources 43

DiagnosticReport

PractitionerOrdering Practitioner

Extension ResultCopiestoPractitioners

PatientDiagnosticReportSubject

Organization

PerformingLab

DiagnosticReport

OrganizationReportingLab

ObservationDiagnosticReportResult

SpecimenDiagnosticReportSpecimen

ProcedureRequestDiagnosticReportProcedureRequest

PractitionerAttendingAdmitting

OrganizationExtension

SpecimenCollectorCenter

OrganizationExtension

DestinationLabOrderPlacer

Encounter

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 15

431 Diagnostic Report Profile

ca-on-Diagnostic-DiagnosticReport based on Diagnostic Report profile httphl7orgfhirdiagnosticreporthtml

Name Card Type ValueVocab Description Comments identifier 11 Identifier Identifier assigned by the sending

organization - this is an identifier assigned outside FHIR

This field contains an identifier for the entire order The Placer Group Number is conceptually equivalent to a requisition number assigned to all test requests in an order by an organization (ORC4)

system 11 Uri

The source of the lab reports (ORC43)

value 11 string The unique identifier of the lab report record (ORC41)

status 11 code Value set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

code CodeableConcept

coding 11 coding Fixed code ldquo11502-2rdquo Code defined by a LOINC text 11 string Fixed value ldquoLaboratory Reportrdquo Plain text representation of the concept

Subject (patient)

11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

issued 01 instant dateTime when test request has been issued An instant in time - known at least to the second and always includes a time zone This field will be populated by system (OBR22)

performer 01 Reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

The individual responsible for reporting test result Can be reporting laboratory or reporting practitioner

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 16

Name Card Type ValueVocab Description Comments reference 11 string A reference to a location at which the

other resource is found

request 1 Reference Contained ca-on-Diagnostic-ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

specimen 01 Reference Contained ca-on-Diagnostic-Specimen (Specimen) resource

Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

Result 1 Reference Contained ca-on-Diagnostic-Observation (Observation) resource

List of all the observation associated with the test request (OBX)

reference 11 string A reference to a location at which the other resource is found

codedDiagnosi

s

01 CodeableCon

cept

Value Set ICD10 Diagnosis information

coding 11 coding A reference to a location at which the other resource is found

text 11 string A reference to a location at which the other resource is found

432 Procedure Request Profile

ca-on-Diagnostic-ProcedureRequest profile based on httphl7orgfhirprocedurerequesthtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier assigned by the ordering facility - this is an identifier assigned outside FHIR Must contain a value assigned by the order-placing organization that uniquely identifies this test request among all test requests in OLIS (OBR2)

system 11 Uri The source of test request on the lab report (OBR23)

value 11 string The unique identifier of the test request record (OBR21)

This represents the test request number from the LIS or HIS systems

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 17

Name Card Type ValueVocab Description Comments

status 11 code Value Set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

intent 11 code Value set httphl7orgfhirValueSetrequest-intent

proposal | plan | original-order | order| reflex-order (OBR11)

If OBR11 contains lsquoGrsquo populate lsquoreflex-testrsquo value otherwise fix the value to lsquoOrderrsquo

priority 11 code Value set httphl7orgfhirValueSetrequest-priority

routine | urgent | asap | stat

RequestPriority (Required) (OBR276)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Context (encounter)

11 Reference Contained ca-on-Diagnostic-Encounter (Encounter) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

occuranceDateTime

11 dateTime When testing should occur (OBR274) For routine orders populate this field with the current date

For timing-critical orders populate this field with the date and time that the specimen is to be obtained

For future-dated orders populate this field with the scheduled future date (and time if applicable) when the laboratory test is to occur

extension

01 DateTime of Transaction (ORC9) Populate this field with the

date and time of the event

that initiated the current

transaction

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 18

url 11 httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-dateTime-transaction

valueDateTime 11 dateTime

requester 11 BackboneElement

agent 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the personorganization making request to perform the test (ordering practitionerorganization OBR16)

IF Ordering Facility exists in the message (ORC21) Scenario 1 requester (OBR16) is organization populate ORC21 with the same organization information that in OBR16 field Scenario 2 requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

onBehalfOf 01 reference Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the organization agent is acting for ordering facility

Should be mapped to ordering facility (ORC21 and ORC22) where requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension CCrsquod list practitioner (OBR28) url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-cc-practitioner-list

valueReference (Practitioner)

110 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Practitioners named on an order (attending admitting ccrsquod)

reference 11 string A reference to a location at which the

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 19

other resource is found extension 01 Extension Test Request Placer ZBR2

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-test-request-placer

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Original Test Request Placer

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension Destination Laboratory ZBR8 url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-destination-laboratory

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Destination Laboratory

reference 11 string A reference to a location at which the other resource is found

note 05 Annotation comments authorString 11 string ZNT segment Indicate the organization

(or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

extension 11 Extension Source of Comment (NTE2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-source-comment

valueString

11 string

extension 11 Extension Set ID (NTE1)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 20

set-id

valueString

11 string

433 Observation Profile

ca-on-Diagnostic-Observation profile based on httphl7orgfhirobservationhtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Unique ID for the particular observation (OBR3)

system 11 uri The namespace for the identifier (OBR32) value 11 string The value that is unique (OBR31)

status 11 code Value set Observation result status (OBX11) code CodeableCo

ncept Value set LOINCSNOMED CT

Test result code (OBX3)

coding 11 coding Code defined by a terminology system (OBX31)

text 11 string Plain text representation of the concept (OBX32)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

effective 01 Clinically relevant time for observation

effectiveDateTime

01 dateTime DateTime of observation OBX141 Use this field for ancillary order only

This field must be empty when a laboratory reports a test result

issued 11 instant Indicate the date and time that the Test Result was released by the Reporting Laboratory (ZBX1)

performer (organization)

11 Reference Contained ca-on-Deagnostic-Organization (Organization) Resource or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

The individual responsible for performing the test Can be laboratory or practitioner

reference 11 string A reference to a location at which the other resource is found

value 11 Actual result

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 21

Name Card Type ValueVocab Description Comments

valueQuantity 11 Quantity (OBX2)-Only numeric test value value 11 decimal Numeric value of the test result (OBX5) unit 01 string When observation Value is a scalar value this

field describes the units of measure (OBX61)

interpretation 01 CodebaleConcept

Observation Interpretation Codes(OBX8)

coding 01 Coding Value set method 01 CodebaleCo

ncept How the observation has been done (OBX17)

text 11 string Plain text (OBX172) specimen 01 Reference Contained ca-on-Diagnostic-

Specimen (Specimen) resource Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

referenceRange 01 BackboneElement

Normal range of value associated with observation result (OBX7)

text 11 string Text based reference range in an observation

extension 01 Extension Nature of Abnormal Test (OBX10)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-nature-abnormal-test

valuecoding

11 coding Value set

extension 01 Extension Observation sub-id (OBX4)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation sort key (ZBX2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation comment (NTE-ZNT)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 22

url 11 uri httpehealthontariocaAPIfhir

StructureDefinitiondiagnosticReport-ext-observation-comment

valueAnnotation

11 annotation

authorString

11 string ZNT segment Indicate the organization (or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

434 Specimen Profile

ca-on-Diagnostic-Specimen profile based on httphl7orgfhirspecimenhtml

Name Card Type ValueVocab Description Comments

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

receivedTime 11 dateTime The time when specimen was received for processing

OBR14

request 1 Reference Contained ca-on-Diagnostic- ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

extension 11 Extension Organization that collected the specimen

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-specimen-collector-center

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Specimen Collector Center (ZBR3)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 23

Name Card Type ValueVocab Description Comments

Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

reference 11 string A reference to a location at which the other resource is found

reference 11 string A reference to a location at which the other resource is found

collected 01 Specimen collection time CollectedPeriod 11 Period

start 01 dateTime Starting specimen time OBR7 end 01 dateTime End specimen time OBR8

type 01 CodeableConcept

Kind of material that forms the specimen (Specimen Type)

OBR15

coding 01 coding Value Set from OLIS Code define by the terminology system

OBR1511

text 01 string Plain text representation of the concept

OBR1512

bodySite 01 CodeableConcept

Value Set Anatomical collection site OBR155

container 01 BackboneElement

Direct container of specimen

identifier 02 identifier Id for container OBR18 andor OBR20 Referring Lab User Specimen Identifier and Performing Lab User Specimen Identifier on Refereed ndashout orders

specimenQuantity

01 SimpleQuantity

Quantity of specimen within container

OBR37

note 01 Annotation Collectors comments text 11 string Collectors comments OBR39

extension 01 Extension Collection volume (OBR9)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-collection-volume

valueQuantity

11 Quantity

value 11 decimal Numeric value of the collection OBR91

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 24

volume unit 01 string Units of measure OBR921

435 Patient Profile

ca-on-Diagnostic-Patient profile based on httphl7orgfhirpatienthtml

Name

Card Type ValueVocab Description Comment

identifier

1 Identifier An identifier for this patient

system 11 uri [id-system-global-base]ca-on-patient-hcn

Patient Identifier Assigning Authority Namespace in which set of possible id values is unique (PID391 PID392 PID393)

Value 11 string Patient Identifier Number The portion of the identifier typically displayed to the user and which is unique within the context of the system (PID31)

extension 01 Health Card Version code (PID311) this is an extension patient identifier

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionext-identifier-hcn-version-code

valueString 11 string name

01 HumanName

use 11 code Value set httphl7orgfhirValueSetname-use

Purpose of this name Name type code PID57

Fix to the official for all cases except for anonymous For anonymous code should be lsquoanonymousrsquo

family 11 string Patient Last Name (PID51) given 02 string Patient First Name(PID52) extension 01 patient middle name (PID53)

this is an extension of given name

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode 11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name (PID55)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 25

Name

Card Type ValueVocab Description Comment

suffix 02 String Parts that come after the name (PID54)

extension 01 Patient degree designation This is an extension of suffix

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoACrdquo Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

telecom 03 Demographics Patient table Telephone Number system 01 code httphl7orgfhir

ValueSetcontact-point-system

Telecommunications form for contact point (Phone fax email pager url sms other) PID133 or PID143

Value 11 string The actual contact point details PID134-PID138 Or PID144-PID148

use 01 code httphl7orgfhirValueSetcontact-point-use

Use of contact point (Home work temp old mobile) PID132 or PID142

gender 11 code ldquomalerdquo ldquofemalerdquo ldquootherrdquo ldquounknownrdquo (httphl7orgfhirValueSetadministrative-gender)

The gender of a person used for administrative purposes (PID8)

birthDate 11 date The date of birth for the individual (PID7) Deceased[x]

01 boolean|dateTime

Indicates if the individual is deceased or not The value must be one of the choices specified below but not both System creating instance of this resource must decide which type to use at run time (PID30)

deceasedBoolean

boolean true|false

deceasedDateTime

dateTime Deceased datetime if known (PID29)

address 12 Address Demographics Patient table Address for the individual (PID11)

use 11 code ValueSet httphl7orgfhir

Address Type The use of an address

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 26

Name

Card Type ValueVocab Description Comment

ValueSetaddress-use

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

line 11 string Street lines (PID111) city 11 string Name of city town etc (PID113) state 01 string Province or territory (PID114) postalCode 01 string Postal code for area (PID115) country 11 string Country (can be ISO 3166 3 letter code) (PID116)

436 Practitioner Profile (Ordering Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent Ordering Practitioner information

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR1622

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR161

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR162 given 12 string Practitioner First Name OBR163

extension

01 Practitioner middle name this is an extension of given name

OBR164

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 7: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 4

Reference Materials 14

Table 1 Reference Materials

Document Name Location

HL7 FHIR STU3 httphl7orgfhir

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 5

2 How to Implement HL7 FHIR

Content Types and Encodings 21

The formal MIME-type for FHIR resources is applicationjson+fhir or applicationxml+fhir The correct mime type SHALL be used by clients and servers

JSON (preferred) applicationjson+fhir

XML (optional) applicationxml+fhir

FHIR uses UTF-8 for all request and response bodies Since the HTTP specification defines a default character encoding of ISO-8859-1 requests and responses

SHALL explicitly set the character encoding to UTF-8 using the charset parameter of the MIME-type in the Content-Type header Requests MAY also specify

this charset parameter in the Accept header andor use the Accept-Charset header

Summary of all FHIR Request Interactions

The table below shows the allowed transactions on FHIR resources and their corresponding HTTP operations

Table 2 OLIS FHIR HTTP Operations

Resource Transaction HTTP Verb

DiagnosticReport Search GET

DiagnosticReport Read GET

Special Case Missing data

In some cases implementers may find that they do not have appropriate data for an element with minimum cardinality = 1 In this case the element must be

present but unless the resource or a profile on it has made the actual value of the primitive data type mandatory it is possible to provide an extension that explains

why the primitive value is not present

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 6

XML

lturigt

ltextension url=httphl7orgfhirStructureDefinitiondata-absent-reasongt

ltvalueCode=unknowngt

ltextensiongt

lturigt

JSON

_uri

extension [

url httphl7orgfhirStructureDefinitiondata-absent-reason

valueCode unknown

]

In this example instead of a value a data missing code is provided (httpswwwhl7orgfhirextension-data-absent-reasonhtml) Note that it is not required that

this particular extension is used This extension is not a modifier extension because the primitive data type has no value

It is not valid to create a fictional piece of data for the primitive value and then to add an extension indicating that the data has been constructed to meet the data

rules This would be both a bad idea and also a modifier extension which is not allowed on data types

Naming Convention

The base URL for OLIS FHIR interface will be referred to as ldquo[base]rdquo in the sections and examples below Please note that base URL might change over time

The base for Naming System (namespace of identifiers and code system of local terminologies) is httpsehealthontariocaAPIFHIRNamingSystem For

globalshareable identifiers (eg Ontario health care number Ontario Physician License etc) this might be replaced with httphl7orgfhirNamingSystemca-

on-license-physician in the future when HL7 FHIR Naming System registry is available The base for global identifier namespaces will be referred to as [id-

system-global-base] in the sections and examples below The base for local identifier namespaces (eg placer group number order number etc) will be referred

to as ldquo[id-system-local-base]rdquo in the sections and examples below The base for local code systems (eg test request code) will be referred to as ldquo[code-system-local-

base]rdquo in the sections and examples below

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 7

Variable Value

[base] httpswsgatewayprodehealthontariocaAPIFHIRLaboratoryv1Diagnostic

Report

[base-structure] httpsehealthontariocaAPIFHIRStructureDefinition

[id-system-global-base] httpsehealthontariocaAPIFHIRNamingSystem

[id-system-local-base] httpsehealthontariocaAPIFHIRNamingSystem

[code-system-local-base] httpsehealthontariocaAPIFHIRNamingSystem

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 8

3 Supported Operations

Search Laboratory Report 31

This interaction searches a set of resources based on some filter criteria The interaction can be performed by several different HTTP commands

GET [base][type][parameters]amp_format=[mime-type]

This searches all resources of a particular type using the criteria represented in the parameters

All these search interactions take a series of parameters that are a series of name=value pairs encoded in the URL (See W3C HTML forms)

If the search fails (cannot be executed not that there is no matches) the return value is a status code 4xx or 5xx with an OperationOutcome If the search succeeds

the return content is a Bundle with type = searchset containing the results of the search as a list of resources in a defined order The result list can be long so server

will use paging (adapted from RFC 5005 (Feed Paging and Archiving) for breaking the list into pages if appropriate (see Paging section below) The server may also

return an OperationOutcome resource with additional information about the search

311 Search Parameter Types

Each search parameter is defined by a type that specifies how the search parameter behaves These are the defined parameter types

number Search parameter SHALL be a number (a whole number or a decimal)

date Search parameter is on a datetime The date format is the standard XML format

string Search parameter is a simple string like a name part Search is case-insensitive and accent-insensitive May match just the start of a string String

parameters may contain spaces

token Search parameter on a coded element or identifier May be used to search through the text displayname code and codecodesystem (for codes) and label

system and key (for identifier) Its value is either a string or a pair of namespace and value separated by a | depending on the modifier used

312 Prefixes

For the ordered parameter types of number date and quantity a prefix to the parameter value may be used to control the nature of the matching To avoid URL

escaping and visual confusion the following prefixes are used

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 9

eq the value for the parameter in the resource is equal to the provided value the range of the search value fully contains the range of the target value

gt the value for the parameter in the resource is greater than the provided value the range above the search value intersects (ie overlaps) with the

range of the target value

lt the value for the parameter in the resource is less than the provided value the range below the search value intersects (ie overlaps) with the

range of the target value

ge the value for the parameter in the resource is greater or equal to the provided value the range above the search value intersects (ie overlaps) with the

range of the target value or the range of the search value fully contains

the range of the target value

le the value for the parameter in the resource is less or equal to the provided value the range below the search value intersects (ie overlaps) with the

range of the target value or the range of the search value fully contains

the range of the target value

If no prefix is present the prefix eq is assumed

313 Supported Search Parameters

GET DiagnosticReport (query by Patient ID) o Patient ID parameter patientpatientidentifier

Only Ontario health card number is allowed as an ID parameter in the current release Example patientpatientidentifier=[id-system-global-base]ca-on-patient-hcn|12345678

o Patient Gender parameter gender patientgender Example patientgender=male

o Patient Date of Birth parameter patientbirthdate Example patientbirthdate=19291129

o Dates parameter issuedstart Example issuedstart=ge20160102

314 Search Example

GET [base] DiagnosticReportspatientpatientidentifier=[id-system-global-base]ca-on-patient-hcn| 1008624486amp patientgender=maleamppatientbirthdate=19291129ampissuedstart=ge20160102

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 10

4 FHIR Resources Definitions

General Overview 41

411 Supported Attributes

Only attributes described in the subsections below will be supported

412 Format

OLIS will support JSON and XML formats JSON is the preferred format

Infrastructure Resources 42

421 Resource - Base Resource Definitions

httpwwwhl7orgFHIRresourcehtml Name Card Type ValueVocab Description Comments id 01 id Unique ID set by FHIR server Logical id of this artifact meta 01 Meta Only ldquolastUpdatedrdquo element to be populated

by FHIR server Metadata about the resource

lastUpdated 01 instant This value changes each time the content of the resource changes

language 01 code Used only for Bundle and fixed to ldquoenrdquo in the current release

Language of the resource content

422 DomainResource Resource

httpwwwhl7orgFHIRdomainresourcehtml

A resource with narrative extensions and contained resources

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 11

If a resource is contained in another resource it SHALL NOT have a metaversionId or a metalastUpdated

If the resource is contained in another resource it SHALL be referred to from elsewhere in the resource

If the resource is contained in another resource it SHALL NOT contain nested Resources

If the resource is contained in another resource it SHALL NOT contain any narrative

Most resources are derived from Domain Resources - so they also can contain text contained resources extensions and data elements specific to the particular

domain of the resource

Name Card Type ValueVocab Description Comments text 01 Narrative Text summary of the resource for human

interpretation Not used in the current release

contained 0 Resource Contained inline Resources extension 0 Extension Additional Content defined by

implementations

modifierExtension

0 Extension Extensions that cannot be ignored

423 Bundle Resource

Based on httpwwwhl7orgFHIRbundlehtml

A special type of resource for collections of resources

A set of search results (type = searchset) consists of a series of zero or more entries Each entry element will contain a resource

Bundletotal may be used to return the total number of resources that match the search and that may be returned by following the next link

Name Card Type ValueVocab Description Comments type 11 code Fixed to ldquosearchsetrdquo Type of bundle total 01 unsignedI

nt The total number of matches

link 0 BackboneElement

Links related to this Bundle Optional element might be returned by a server

relation 11 string ldquoselfrdquo for the link to the this Bundle ldquonextrdquo for the link to the next page

ValueSet httpwwwianaorgassignmentslink-relationslink-relationsxhtml

url 11 uri Reference details for the link entry 0 Backbone

Element Entry in the bundle - will have a resource

or information

fullUrl 01 uri The fullUrl element must be present when a resource is present and not present otherwise

Absolute URL for resource (server address or UUIDOID)

resource 01 Resource A resource in the bundle

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 12

424 OperationOutcome Resource

Based on httphl7orgfhiroperationoutcomehtml

Operation Outcomes are sets of error warning and information messages that provide detailed information about the outcome of some attempted system

operation They are provided as a direct system response or component of one where they provide information about the outcome of the operation

OperationOutcomes are used in the following circumstances

When an RESTful operation fails

As the response on a validation operation to provide information about the outcomes

As part of a message response usually when the message has not been processed correctly

This resource is not used for reporting clinical or workflow issues associated with a proposed or ongoing action The resource is not designed to be persisted or

referenced from other parts of the workflow

Name Card

Type ValueVocab Description Comments

issue 1 BackboneElement

A single issue associated with the action

severity 11 code ValueSethttphl7orgfhirvalueset-issue-severityhtml

fatal | error | warning | information

code 11 ValueSethttphl7orgfhirvalueset-issue-typehtml

Error or warning code

details 01 CodeableConcept

ValueSet httphl7orgfhirvalueset-operation-outcomehtml

Additional details about the error

diagnostics 01 string Additional diagnostic information about the issue

location 0 string XPath of element(s) related to issue

425 Using Operation Outcome Resources

On the RESTful interface operation outcome resources are only relevant when a level of computable detail is required that is more granular than that provided by

the HTTP response codes This granularity could include

more detail about the location of an issue

the ability to identify multiple distinct issues

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 13

provision of finer error codes that connect to known business failure states

426 Reporting Errors in the HTTP Headers

Server may also need to report errors in the HTTP headers - especially query parameters when processing searches Errors are reported using a case sensitive

location that has two parts a fixed http and the header or query parameter name separated by a Some examples

Location Description

httpnameexact A reference to the search parameter name with the modifier exact

httpAuthorization A reference to the Authorization header - perhaps to indicate that it is missing and some form of authentication is required

427 OperationOutcome Example - Search

resourceType OperationOutcome

id OperationOutcome1234

issue [

severity fatal

code code-invalid

details

text The name parameter has the modifier exact which is not supported by this server

location [

httpnameexact

]

]

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 14

FHIR Resources 43

DiagnosticReport

PractitionerOrdering Practitioner

Extension ResultCopiestoPractitioners

PatientDiagnosticReportSubject

Organization

PerformingLab

DiagnosticReport

OrganizationReportingLab

ObservationDiagnosticReportResult

SpecimenDiagnosticReportSpecimen

ProcedureRequestDiagnosticReportProcedureRequest

PractitionerAttendingAdmitting

OrganizationExtension

SpecimenCollectorCenter

OrganizationExtension

DestinationLabOrderPlacer

Encounter

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 15

431 Diagnostic Report Profile

ca-on-Diagnostic-DiagnosticReport based on Diagnostic Report profile httphl7orgfhirdiagnosticreporthtml

Name Card Type ValueVocab Description Comments identifier 11 Identifier Identifier assigned by the sending

organization - this is an identifier assigned outside FHIR

This field contains an identifier for the entire order The Placer Group Number is conceptually equivalent to a requisition number assigned to all test requests in an order by an organization (ORC4)

system 11 Uri

The source of the lab reports (ORC43)

value 11 string The unique identifier of the lab report record (ORC41)

status 11 code Value set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

code CodeableConcept

coding 11 coding Fixed code ldquo11502-2rdquo Code defined by a LOINC text 11 string Fixed value ldquoLaboratory Reportrdquo Plain text representation of the concept

Subject (patient)

11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

issued 01 instant dateTime when test request has been issued An instant in time - known at least to the second and always includes a time zone This field will be populated by system (OBR22)

performer 01 Reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

The individual responsible for reporting test result Can be reporting laboratory or reporting practitioner

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 16

Name Card Type ValueVocab Description Comments reference 11 string A reference to a location at which the

other resource is found

request 1 Reference Contained ca-on-Diagnostic-ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

specimen 01 Reference Contained ca-on-Diagnostic-Specimen (Specimen) resource

Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

Result 1 Reference Contained ca-on-Diagnostic-Observation (Observation) resource

List of all the observation associated with the test request (OBX)

reference 11 string A reference to a location at which the other resource is found

codedDiagnosi

s

01 CodeableCon

cept

Value Set ICD10 Diagnosis information

coding 11 coding A reference to a location at which the other resource is found

text 11 string A reference to a location at which the other resource is found

432 Procedure Request Profile

ca-on-Diagnostic-ProcedureRequest profile based on httphl7orgfhirprocedurerequesthtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier assigned by the ordering facility - this is an identifier assigned outside FHIR Must contain a value assigned by the order-placing organization that uniquely identifies this test request among all test requests in OLIS (OBR2)

system 11 Uri The source of test request on the lab report (OBR23)

value 11 string The unique identifier of the test request record (OBR21)

This represents the test request number from the LIS or HIS systems

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 17

Name Card Type ValueVocab Description Comments

status 11 code Value Set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

intent 11 code Value set httphl7orgfhirValueSetrequest-intent

proposal | plan | original-order | order| reflex-order (OBR11)

If OBR11 contains lsquoGrsquo populate lsquoreflex-testrsquo value otherwise fix the value to lsquoOrderrsquo

priority 11 code Value set httphl7orgfhirValueSetrequest-priority

routine | urgent | asap | stat

RequestPriority (Required) (OBR276)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Context (encounter)

11 Reference Contained ca-on-Diagnostic-Encounter (Encounter) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

occuranceDateTime

11 dateTime When testing should occur (OBR274) For routine orders populate this field with the current date

For timing-critical orders populate this field with the date and time that the specimen is to be obtained

For future-dated orders populate this field with the scheduled future date (and time if applicable) when the laboratory test is to occur

extension

01 DateTime of Transaction (ORC9) Populate this field with the

date and time of the event

that initiated the current

transaction

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 18

url 11 httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-dateTime-transaction

valueDateTime 11 dateTime

requester 11 BackboneElement

agent 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the personorganization making request to perform the test (ordering practitionerorganization OBR16)

IF Ordering Facility exists in the message (ORC21) Scenario 1 requester (OBR16) is organization populate ORC21 with the same organization information that in OBR16 field Scenario 2 requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

onBehalfOf 01 reference Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the organization agent is acting for ordering facility

Should be mapped to ordering facility (ORC21 and ORC22) where requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension CCrsquod list practitioner (OBR28) url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-cc-practitioner-list

valueReference (Practitioner)

110 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Practitioners named on an order (attending admitting ccrsquod)

reference 11 string A reference to a location at which the

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 19

other resource is found extension 01 Extension Test Request Placer ZBR2

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-test-request-placer

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Original Test Request Placer

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension Destination Laboratory ZBR8 url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-destination-laboratory

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Destination Laboratory

reference 11 string A reference to a location at which the other resource is found

note 05 Annotation comments authorString 11 string ZNT segment Indicate the organization

(or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

extension 11 Extension Source of Comment (NTE2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-source-comment

valueString

11 string

extension 11 Extension Set ID (NTE1)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 20

set-id

valueString

11 string

433 Observation Profile

ca-on-Diagnostic-Observation profile based on httphl7orgfhirobservationhtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Unique ID for the particular observation (OBR3)

system 11 uri The namespace for the identifier (OBR32) value 11 string The value that is unique (OBR31)

status 11 code Value set Observation result status (OBX11) code CodeableCo

ncept Value set LOINCSNOMED CT

Test result code (OBX3)

coding 11 coding Code defined by a terminology system (OBX31)

text 11 string Plain text representation of the concept (OBX32)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

effective 01 Clinically relevant time for observation

effectiveDateTime

01 dateTime DateTime of observation OBX141 Use this field for ancillary order only

This field must be empty when a laboratory reports a test result

issued 11 instant Indicate the date and time that the Test Result was released by the Reporting Laboratory (ZBX1)

performer (organization)

11 Reference Contained ca-on-Deagnostic-Organization (Organization) Resource or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

The individual responsible for performing the test Can be laboratory or practitioner

reference 11 string A reference to a location at which the other resource is found

value 11 Actual result

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 21

Name Card Type ValueVocab Description Comments

valueQuantity 11 Quantity (OBX2)-Only numeric test value value 11 decimal Numeric value of the test result (OBX5) unit 01 string When observation Value is a scalar value this

field describes the units of measure (OBX61)

interpretation 01 CodebaleConcept

Observation Interpretation Codes(OBX8)

coding 01 Coding Value set method 01 CodebaleCo

ncept How the observation has been done (OBX17)

text 11 string Plain text (OBX172) specimen 01 Reference Contained ca-on-Diagnostic-

Specimen (Specimen) resource Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

referenceRange 01 BackboneElement

Normal range of value associated with observation result (OBX7)

text 11 string Text based reference range in an observation

extension 01 Extension Nature of Abnormal Test (OBX10)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-nature-abnormal-test

valuecoding

11 coding Value set

extension 01 Extension Observation sub-id (OBX4)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation sort key (ZBX2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation comment (NTE-ZNT)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 22

url 11 uri httpehealthontariocaAPIfhir

StructureDefinitiondiagnosticReport-ext-observation-comment

valueAnnotation

11 annotation

authorString

11 string ZNT segment Indicate the organization (or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

434 Specimen Profile

ca-on-Diagnostic-Specimen profile based on httphl7orgfhirspecimenhtml

Name Card Type ValueVocab Description Comments

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

receivedTime 11 dateTime The time when specimen was received for processing

OBR14

request 1 Reference Contained ca-on-Diagnostic- ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

extension 11 Extension Organization that collected the specimen

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-specimen-collector-center

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Specimen Collector Center (ZBR3)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 23

Name Card Type ValueVocab Description Comments

Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

reference 11 string A reference to a location at which the other resource is found

reference 11 string A reference to a location at which the other resource is found

collected 01 Specimen collection time CollectedPeriod 11 Period

start 01 dateTime Starting specimen time OBR7 end 01 dateTime End specimen time OBR8

type 01 CodeableConcept

Kind of material that forms the specimen (Specimen Type)

OBR15

coding 01 coding Value Set from OLIS Code define by the terminology system

OBR1511

text 01 string Plain text representation of the concept

OBR1512

bodySite 01 CodeableConcept

Value Set Anatomical collection site OBR155

container 01 BackboneElement

Direct container of specimen

identifier 02 identifier Id for container OBR18 andor OBR20 Referring Lab User Specimen Identifier and Performing Lab User Specimen Identifier on Refereed ndashout orders

specimenQuantity

01 SimpleQuantity

Quantity of specimen within container

OBR37

note 01 Annotation Collectors comments text 11 string Collectors comments OBR39

extension 01 Extension Collection volume (OBR9)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-collection-volume

valueQuantity

11 Quantity

value 11 decimal Numeric value of the collection OBR91

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 24

volume unit 01 string Units of measure OBR921

435 Patient Profile

ca-on-Diagnostic-Patient profile based on httphl7orgfhirpatienthtml

Name

Card Type ValueVocab Description Comment

identifier

1 Identifier An identifier for this patient

system 11 uri [id-system-global-base]ca-on-patient-hcn

Patient Identifier Assigning Authority Namespace in which set of possible id values is unique (PID391 PID392 PID393)

Value 11 string Patient Identifier Number The portion of the identifier typically displayed to the user and which is unique within the context of the system (PID31)

extension 01 Health Card Version code (PID311) this is an extension patient identifier

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionext-identifier-hcn-version-code

valueString 11 string name

01 HumanName

use 11 code Value set httphl7orgfhirValueSetname-use

Purpose of this name Name type code PID57

Fix to the official for all cases except for anonymous For anonymous code should be lsquoanonymousrsquo

family 11 string Patient Last Name (PID51) given 02 string Patient First Name(PID52) extension 01 patient middle name (PID53)

this is an extension of given name

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode 11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name (PID55)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 25

Name

Card Type ValueVocab Description Comment

suffix 02 String Parts that come after the name (PID54)

extension 01 Patient degree designation This is an extension of suffix

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoACrdquo Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

telecom 03 Demographics Patient table Telephone Number system 01 code httphl7orgfhir

ValueSetcontact-point-system

Telecommunications form for contact point (Phone fax email pager url sms other) PID133 or PID143

Value 11 string The actual contact point details PID134-PID138 Or PID144-PID148

use 01 code httphl7orgfhirValueSetcontact-point-use

Use of contact point (Home work temp old mobile) PID132 or PID142

gender 11 code ldquomalerdquo ldquofemalerdquo ldquootherrdquo ldquounknownrdquo (httphl7orgfhirValueSetadministrative-gender)

The gender of a person used for administrative purposes (PID8)

birthDate 11 date The date of birth for the individual (PID7) Deceased[x]

01 boolean|dateTime

Indicates if the individual is deceased or not The value must be one of the choices specified below but not both System creating instance of this resource must decide which type to use at run time (PID30)

deceasedBoolean

boolean true|false

deceasedDateTime

dateTime Deceased datetime if known (PID29)

address 12 Address Demographics Patient table Address for the individual (PID11)

use 11 code ValueSet httphl7orgfhir

Address Type The use of an address

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 26

Name

Card Type ValueVocab Description Comment

ValueSetaddress-use

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

line 11 string Street lines (PID111) city 11 string Name of city town etc (PID113) state 01 string Province or territory (PID114) postalCode 01 string Postal code for area (PID115) country 11 string Country (can be ISO 3166 3 letter code) (PID116)

436 Practitioner Profile (Ordering Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent Ordering Practitioner information

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR1622

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR161

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR162 given 12 string Practitioner First Name OBR163

extension

01 Practitioner middle name this is an extension of given name

OBR164

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 8: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 5

2 How to Implement HL7 FHIR

Content Types and Encodings 21

The formal MIME-type for FHIR resources is applicationjson+fhir or applicationxml+fhir The correct mime type SHALL be used by clients and servers

JSON (preferred) applicationjson+fhir

XML (optional) applicationxml+fhir

FHIR uses UTF-8 for all request and response bodies Since the HTTP specification defines a default character encoding of ISO-8859-1 requests and responses

SHALL explicitly set the character encoding to UTF-8 using the charset parameter of the MIME-type in the Content-Type header Requests MAY also specify

this charset parameter in the Accept header andor use the Accept-Charset header

Summary of all FHIR Request Interactions

The table below shows the allowed transactions on FHIR resources and their corresponding HTTP operations

Table 2 OLIS FHIR HTTP Operations

Resource Transaction HTTP Verb

DiagnosticReport Search GET

DiagnosticReport Read GET

Special Case Missing data

In some cases implementers may find that they do not have appropriate data for an element with minimum cardinality = 1 In this case the element must be

present but unless the resource or a profile on it has made the actual value of the primitive data type mandatory it is possible to provide an extension that explains

why the primitive value is not present

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 6

XML

lturigt

ltextension url=httphl7orgfhirStructureDefinitiondata-absent-reasongt

ltvalueCode=unknowngt

ltextensiongt

lturigt

JSON

_uri

extension [

url httphl7orgfhirStructureDefinitiondata-absent-reason

valueCode unknown

]

In this example instead of a value a data missing code is provided (httpswwwhl7orgfhirextension-data-absent-reasonhtml) Note that it is not required that

this particular extension is used This extension is not a modifier extension because the primitive data type has no value

It is not valid to create a fictional piece of data for the primitive value and then to add an extension indicating that the data has been constructed to meet the data

rules This would be both a bad idea and also a modifier extension which is not allowed on data types

Naming Convention

The base URL for OLIS FHIR interface will be referred to as ldquo[base]rdquo in the sections and examples below Please note that base URL might change over time

The base for Naming System (namespace of identifiers and code system of local terminologies) is httpsehealthontariocaAPIFHIRNamingSystem For

globalshareable identifiers (eg Ontario health care number Ontario Physician License etc) this might be replaced with httphl7orgfhirNamingSystemca-

on-license-physician in the future when HL7 FHIR Naming System registry is available The base for global identifier namespaces will be referred to as [id-

system-global-base] in the sections and examples below The base for local identifier namespaces (eg placer group number order number etc) will be referred

to as ldquo[id-system-local-base]rdquo in the sections and examples below The base for local code systems (eg test request code) will be referred to as ldquo[code-system-local-

base]rdquo in the sections and examples below

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 7

Variable Value

[base] httpswsgatewayprodehealthontariocaAPIFHIRLaboratoryv1Diagnostic

Report

[base-structure] httpsehealthontariocaAPIFHIRStructureDefinition

[id-system-global-base] httpsehealthontariocaAPIFHIRNamingSystem

[id-system-local-base] httpsehealthontariocaAPIFHIRNamingSystem

[code-system-local-base] httpsehealthontariocaAPIFHIRNamingSystem

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 8

3 Supported Operations

Search Laboratory Report 31

This interaction searches a set of resources based on some filter criteria The interaction can be performed by several different HTTP commands

GET [base][type][parameters]amp_format=[mime-type]

This searches all resources of a particular type using the criteria represented in the parameters

All these search interactions take a series of parameters that are a series of name=value pairs encoded in the URL (See W3C HTML forms)

If the search fails (cannot be executed not that there is no matches) the return value is a status code 4xx or 5xx with an OperationOutcome If the search succeeds

the return content is a Bundle with type = searchset containing the results of the search as a list of resources in a defined order The result list can be long so server

will use paging (adapted from RFC 5005 (Feed Paging and Archiving) for breaking the list into pages if appropriate (see Paging section below) The server may also

return an OperationOutcome resource with additional information about the search

311 Search Parameter Types

Each search parameter is defined by a type that specifies how the search parameter behaves These are the defined parameter types

number Search parameter SHALL be a number (a whole number or a decimal)

date Search parameter is on a datetime The date format is the standard XML format

string Search parameter is a simple string like a name part Search is case-insensitive and accent-insensitive May match just the start of a string String

parameters may contain spaces

token Search parameter on a coded element or identifier May be used to search through the text displayname code and codecodesystem (for codes) and label

system and key (for identifier) Its value is either a string or a pair of namespace and value separated by a | depending on the modifier used

312 Prefixes

For the ordered parameter types of number date and quantity a prefix to the parameter value may be used to control the nature of the matching To avoid URL

escaping and visual confusion the following prefixes are used

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 9

eq the value for the parameter in the resource is equal to the provided value the range of the search value fully contains the range of the target value

gt the value for the parameter in the resource is greater than the provided value the range above the search value intersects (ie overlaps) with the

range of the target value

lt the value for the parameter in the resource is less than the provided value the range below the search value intersects (ie overlaps) with the

range of the target value

ge the value for the parameter in the resource is greater or equal to the provided value the range above the search value intersects (ie overlaps) with the

range of the target value or the range of the search value fully contains

the range of the target value

le the value for the parameter in the resource is less or equal to the provided value the range below the search value intersects (ie overlaps) with the

range of the target value or the range of the search value fully contains

the range of the target value

If no prefix is present the prefix eq is assumed

313 Supported Search Parameters

GET DiagnosticReport (query by Patient ID) o Patient ID parameter patientpatientidentifier

Only Ontario health card number is allowed as an ID parameter in the current release Example patientpatientidentifier=[id-system-global-base]ca-on-patient-hcn|12345678

o Patient Gender parameter gender patientgender Example patientgender=male

o Patient Date of Birth parameter patientbirthdate Example patientbirthdate=19291129

o Dates parameter issuedstart Example issuedstart=ge20160102

314 Search Example

GET [base] DiagnosticReportspatientpatientidentifier=[id-system-global-base]ca-on-patient-hcn| 1008624486amp patientgender=maleamppatientbirthdate=19291129ampissuedstart=ge20160102

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 10

4 FHIR Resources Definitions

General Overview 41

411 Supported Attributes

Only attributes described in the subsections below will be supported

412 Format

OLIS will support JSON and XML formats JSON is the preferred format

Infrastructure Resources 42

421 Resource - Base Resource Definitions

httpwwwhl7orgFHIRresourcehtml Name Card Type ValueVocab Description Comments id 01 id Unique ID set by FHIR server Logical id of this artifact meta 01 Meta Only ldquolastUpdatedrdquo element to be populated

by FHIR server Metadata about the resource

lastUpdated 01 instant This value changes each time the content of the resource changes

language 01 code Used only for Bundle and fixed to ldquoenrdquo in the current release

Language of the resource content

422 DomainResource Resource

httpwwwhl7orgFHIRdomainresourcehtml

A resource with narrative extensions and contained resources

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 11

If a resource is contained in another resource it SHALL NOT have a metaversionId or a metalastUpdated

If the resource is contained in another resource it SHALL be referred to from elsewhere in the resource

If the resource is contained in another resource it SHALL NOT contain nested Resources

If the resource is contained in another resource it SHALL NOT contain any narrative

Most resources are derived from Domain Resources - so they also can contain text contained resources extensions and data elements specific to the particular

domain of the resource

Name Card Type ValueVocab Description Comments text 01 Narrative Text summary of the resource for human

interpretation Not used in the current release

contained 0 Resource Contained inline Resources extension 0 Extension Additional Content defined by

implementations

modifierExtension

0 Extension Extensions that cannot be ignored

423 Bundle Resource

Based on httpwwwhl7orgFHIRbundlehtml

A special type of resource for collections of resources

A set of search results (type = searchset) consists of a series of zero or more entries Each entry element will contain a resource

Bundletotal may be used to return the total number of resources that match the search and that may be returned by following the next link

Name Card Type ValueVocab Description Comments type 11 code Fixed to ldquosearchsetrdquo Type of bundle total 01 unsignedI

nt The total number of matches

link 0 BackboneElement

Links related to this Bundle Optional element might be returned by a server

relation 11 string ldquoselfrdquo for the link to the this Bundle ldquonextrdquo for the link to the next page

ValueSet httpwwwianaorgassignmentslink-relationslink-relationsxhtml

url 11 uri Reference details for the link entry 0 Backbone

Element Entry in the bundle - will have a resource

or information

fullUrl 01 uri The fullUrl element must be present when a resource is present and not present otherwise

Absolute URL for resource (server address or UUIDOID)

resource 01 Resource A resource in the bundle

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 12

424 OperationOutcome Resource

Based on httphl7orgfhiroperationoutcomehtml

Operation Outcomes are sets of error warning and information messages that provide detailed information about the outcome of some attempted system

operation They are provided as a direct system response or component of one where they provide information about the outcome of the operation

OperationOutcomes are used in the following circumstances

When an RESTful operation fails

As the response on a validation operation to provide information about the outcomes

As part of a message response usually when the message has not been processed correctly

This resource is not used for reporting clinical or workflow issues associated with a proposed or ongoing action The resource is not designed to be persisted or

referenced from other parts of the workflow

Name Card

Type ValueVocab Description Comments

issue 1 BackboneElement

A single issue associated with the action

severity 11 code ValueSethttphl7orgfhirvalueset-issue-severityhtml

fatal | error | warning | information

code 11 ValueSethttphl7orgfhirvalueset-issue-typehtml

Error or warning code

details 01 CodeableConcept

ValueSet httphl7orgfhirvalueset-operation-outcomehtml

Additional details about the error

diagnostics 01 string Additional diagnostic information about the issue

location 0 string XPath of element(s) related to issue

425 Using Operation Outcome Resources

On the RESTful interface operation outcome resources are only relevant when a level of computable detail is required that is more granular than that provided by

the HTTP response codes This granularity could include

more detail about the location of an issue

the ability to identify multiple distinct issues

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 13

provision of finer error codes that connect to known business failure states

426 Reporting Errors in the HTTP Headers

Server may also need to report errors in the HTTP headers - especially query parameters when processing searches Errors are reported using a case sensitive

location that has two parts a fixed http and the header or query parameter name separated by a Some examples

Location Description

httpnameexact A reference to the search parameter name with the modifier exact

httpAuthorization A reference to the Authorization header - perhaps to indicate that it is missing and some form of authentication is required

427 OperationOutcome Example - Search

resourceType OperationOutcome

id OperationOutcome1234

issue [

severity fatal

code code-invalid

details

text The name parameter has the modifier exact which is not supported by this server

location [

httpnameexact

]

]

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 14

FHIR Resources 43

DiagnosticReport

PractitionerOrdering Practitioner

Extension ResultCopiestoPractitioners

PatientDiagnosticReportSubject

Organization

PerformingLab

DiagnosticReport

OrganizationReportingLab

ObservationDiagnosticReportResult

SpecimenDiagnosticReportSpecimen

ProcedureRequestDiagnosticReportProcedureRequest

PractitionerAttendingAdmitting

OrganizationExtension

SpecimenCollectorCenter

OrganizationExtension

DestinationLabOrderPlacer

Encounter

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 15

431 Diagnostic Report Profile

ca-on-Diagnostic-DiagnosticReport based on Diagnostic Report profile httphl7orgfhirdiagnosticreporthtml

Name Card Type ValueVocab Description Comments identifier 11 Identifier Identifier assigned by the sending

organization - this is an identifier assigned outside FHIR

This field contains an identifier for the entire order The Placer Group Number is conceptually equivalent to a requisition number assigned to all test requests in an order by an organization (ORC4)

system 11 Uri

The source of the lab reports (ORC43)

value 11 string The unique identifier of the lab report record (ORC41)

status 11 code Value set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

code CodeableConcept

coding 11 coding Fixed code ldquo11502-2rdquo Code defined by a LOINC text 11 string Fixed value ldquoLaboratory Reportrdquo Plain text representation of the concept

Subject (patient)

11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

issued 01 instant dateTime when test request has been issued An instant in time - known at least to the second and always includes a time zone This field will be populated by system (OBR22)

performer 01 Reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

The individual responsible for reporting test result Can be reporting laboratory or reporting practitioner

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 16

Name Card Type ValueVocab Description Comments reference 11 string A reference to a location at which the

other resource is found

request 1 Reference Contained ca-on-Diagnostic-ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

specimen 01 Reference Contained ca-on-Diagnostic-Specimen (Specimen) resource

Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

Result 1 Reference Contained ca-on-Diagnostic-Observation (Observation) resource

List of all the observation associated with the test request (OBX)

reference 11 string A reference to a location at which the other resource is found

codedDiagnosi

s

01 CodeableCon

cept

Value Set ICD10 Diagnosis information

coding 11 coding A reference to a location at which the other resource is found

text 11 string A reference to a location at which the other resource is found

432 Procedure Request Profile

ca-on-Diagnostic-ProcedureRequest profile based on httphl7orgfhirprocedurerequesthtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier assigned by the ordering facility - this is an identifier assigned outside FHIR Must contain a value assigned by the order-placing organization that uniquely identifies this test request among all test requests in OLIS (OBR2)

system 11 Uri The source of test request on the lab report (OBR23)

value 11 string The unique identifier of the test request record (OBR21)

This represents the test request number from the LIS or HIS systems

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 17

Name Card Type ValueVocab Description Comments

status 11 code Value Set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

intent 11 code Value set httphl7orgfhirValueSetrequest-intent

proposal | plan | original-order | order| reflex-order (OBR11)

If OBR11 contains lsquoGrsquo populate lsquoreflex-testrsquo value otherwise fix the value to lsquoOrderrsquo

priority 11 code Value set httphl7orgfhirValueSetrequest-priority

routine | urgent | asap | stat

RequestPriority (Required) (OBR276)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Context (encounter)

11 Reference Contained ca-on-Diagnostic-Encounter (Encounter) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

occuranceDateTime

11 dateTime When testing should occur (OBR274) For routine orders populate this field with the current date

For timing-critical orders populate this field with the date and time that the specimen is to be obtained

For future-dated orders populate this field with the scheduled future date (and time if applicable) when the laboratory test is to occur

extension

01 DateTime of Transaction (ORC9) Populate this field with the

date and time of the event

that initiated the current

transaction

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 18

url 11 httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-dateTime-transaction

valueDateTime 11 dateTime

requester 11 BackboneElement

agent 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the personorganization making request to perform the test (ordering practitionerorganization OBR16)

IF Ordering Facility exists in the message (ORC21) Scenario 1 requester (OBR16) is organization populate ORC21 with the same organization information that in OBR16 field Scenario 2 requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

onBehalfOf 01 reference Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the organization agent is acting for ordering facility

Should be mapped to ordering facility (ORC21 and ORC22) where requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension CCrsquod list practitioner (OBR28) url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-cc-practitioner-list

valueReference (Practitioner)

110 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Practitioners named on an order (attending admitting ccrsquod)

reference 11 string A reference to a location at which the

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 19

other resource is found extension 01 Extension Test Request Placer ZBR2

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-test-request-placer

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Original Test Request Placer

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension Destination Laboratory ZBR8 url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-destination-laboratory

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Destination Laboratory

reference 11 string A reference to a location at which the other resource is found

note 05 Annotation comments authorString 11 string ZNT segment Indicate the organization

(or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

extension 11 Extension Source of Comment (NTE2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-source-comment

valueString

11 string

extension 11 Extension Set ID (NTE1)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 20

set-id

valueString

11 string

433 Observation Profile

ca-on-Diagnostic-Observation profile based on httphl7orgfhirobservationhtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Unique ID for the particular observation (OBR3)

system 11 uri The namespace for the identifier (OBR32) value 11 string The value that is unique (OBR31)

status 11 code Value set Observation result status (OBX11) code CodeableCo

ncept Value set LOINCSNOMED CT

Test result code (OBX3)

coding 11 coding Code defined by a terminology system (OBX31)

text 11 string Plain text representation of the concept (OBX32)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

effective 01 Clinically relevant time for observation

effectiveDateTime

01 dateTime DateTime of observation OBX141 Use this field for ancillary order only

This field must be empty when a laboratory reports a test result

issued 11 instant Indicate the date and time that the Test Result was released by the Reporting Laboratory (ZBX1)

performer (organization)

11 Reference Contained ca-on-Deagnostic-Organization (Organization) Resource or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

The individual responsible for performing the test Can be laboratory or practitioner

reference 11 string A reference to a location at which the other resource is found

value 11 Actual result

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 21

Name Card Type ValueVocab Description Comments

valueQuantity 11 Quantity (OBX2)-Only numeric test value value 11 decimal Numeric value of the test result (OBX5) unit 01 string When observation Value is a scalar value this

field describes the units of measure (OBX61)

interpretation 01 CodebaleConcept

Observation Interpretation Codes(OBX8)

coding 01 Coding Value set method 01 CodebaleCo

ncept How the observation has been done (OBX17)

text 11 string Plain text (OBX172) specimen 01 Reference Contained ca-on-Diagnostic-

Specimen (Specimen) resource Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

referenceRange 01 BackboneElement

Normal range of value associated with observation result (OBX7)

text 11 string Text based reference range in an observation

extension 01 Extension Nature of Abnormal Test (OBX10)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-nature-abnormal-test

valuecoding

11 coding Value set

extension 01 Extension Observation sub-id (OBX4)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation sort key (ZBX2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation comment (NTE-ZNT)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 22

url 11 uri httpehealthontariocaAPIfhir

StructureDefinitiondiagnosticReport-ext-observation-comment

valueAnnotation

11 annotation

authorString

11 string ZNT segment Indicate the organization (or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

434 Specimen Profile

ca-on-Diagnostic-Specimen profile based on httphl7orgfhirspecimenhtml

Name Card Type ValueVocab Description Comments

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

receivedTime 11 dateTime The time when specimen was received for processing

OBR14

request 1 Reference Contained ca-on-Diagnostic- ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

extension 11 Extension Organization that collected the specimen

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-specimen-collector-center

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Specimen Collector Center (ZBR3)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 23

Name Card Type ValueVocab Description Comments

Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

reference 11 string A reference to a location at which the other resource is found

reference 11 string A reference to a location at which the other resource is found

collected 01 Specimen collection time CollectedPeriod 11 Period

start 01 dateTime Starting specimen time OBR7 end 01 dateTime End specimen time OBR8

type 01 CodeableConcept

Kind of material that forms the specimen (Specimen Type)

OBR15

coding 01 coding Value Set from OLIS Code define by the terminology system

OBR1511

text 01 string Plain text representation of the concept

OBR1512

bodySite 01 CodeableConcept

Value Set Anatomical collection site OBR155

container 01 BackboneElement

Direct container of specimen

identifier 02 identifier Id for container OBR18 andor OBR20 Referring Lab User Specimen Identifier and Performing Lab User Specimen Identifier on Refereed ndashout orders

specimenQuantity

01 SimpleQuantity

Quantity of specimen within container

OBR37

note 01 Annotation Collectors comments text 11 string Collectors comments OBR39

extension 01 Extension Collection volume (OBR9)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-collection-volume

valueQuantity

11 Quantity

value 11 decimal Numeric value of the collection OBR91

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 24

volume unit 01 string Units of measure OBR921

435 Patient Profile

ca-on-Diagnostic-Patient profile based on httphl7orgfhirpatienthtml

Name

Card Type ValueVocab Description Comment

identifier

1 Identifier An identifier for this patient

system 11 uri [id-system-global-base]ca-on-patient-hcn

Patient Identifier Assigning Authority Namespace in which set of possible id values is unique (PID391 PID392 PID393)

Value 11 string Patient Identifier Number The portion of the identifier typically displayed to the user and which is unique within the context of the system (PID31)

extension 01 Health Card Version code (PID311) this is an extension patient identifier

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionext-identifier-hcn-version-code

valueString 11 string name

01 HumanName

use 11 code Value set httphl7orgfhirValueSetname-use

Purpose of this name Name type code PID57

Fix to the official for all cases except for anonymous For anonymous code should be lsquoanonymousrsquo

family 11 string Patient Last Name (PID51) given 02 string Patient First Name(PID52) extension 01 patient middle name (PID53)

this is an extension of given name

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode 11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name (PID55)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 25

Name

Card Type ValueVocab Description Comment

suffix 02 String Parts that come after the name (PID54)

extension 01 Patient degree designation This is an extension of suffix

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoACrdquo Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

telecom 03 Demographics Patient table Telephone Number system 01 code httphl7orgfhir

ValueSetcontact-point-system

Telecommunications form for contact point (Phone fax email pager url sms other) PID133 or PID143

Value 11 string The actual contact point details PID134-PID138 Or PID144-PID148

use 01 code httphl7orgfhirValueSetcontact-point-use

Use of contact point (Home work temp old mobile) PID132 or PID142

gender 11 code ldquomalerdquo ldquofemalerdquo ldquootherrdquo ldquounknownrdquo (httphl7orgfhirValueSetadministrative-gender)

The gender of a person used for administrative purposes (PID8)

birthDate 11 date The date of birth for the individual (PID7) Deceased[x]

01 boolean|dateTime

Indicates if the individual is deceased or not The value must be one of the choices specified below but not both System creating instance of this resource must decide which type to use at run time (PID30)

deceasedBoolean

boolean true|false

deceasedDateTime

dateTime Deceased datetime if known (PID29)

address 12 Address Demographics Patient table Address for the individual (PID11)

use 11 code ValueSet httphl7orgfhir

Address Type The use of an address

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 26

Name

Card Type ValueVocab Description Comment

ValueSetaddress-use

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

line 11 string Street lines (PID111) city 11 string Name of city town etc (PID113) state 01 string Province or territory (PID114) postalCode 01 string Postal code for area (PID115) country 11 string Country (can be ISO 3166 3 letter code) (PID116)

436 Practitioner Profile (Ordering Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent Ordering Practitioner information

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR1622

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR161

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR162 given 12 string Practitioner First Name OBR163

extension

01 Practitioner middle name this is an extension of given name

OBR164

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 9: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 6

XML

lturigt

ltextension url=httphl7orgfhirStructureDefinitiondata-absent-reasongt

ltvalueCode=unknowngt

ltextensiongt

lturigt

JSON

_uri

extension [

url httphl7orgfhirStructureDefinitiondata-absent-reason

valueCode unknown

]

In this example instead of a value a data missing code is provided (httpswwwhl7orgfhirextension-data-absent-reasonhtml) Note that it is not required that

this particular extension is used This extension is not a modifier extension because the primitive data type has no value

It is not valid to create a fictional piece of data for the primitive value and then to add an extension indicating that the data has been constructed to meet the data

rules This would be both a bad idea and also a modifier extension which is not allowed on data types

Naming Convention

The base URL for OLIS FHIR interface will be referred to as ldquo[base]rdquo in the sections and examples below Please note that base URL might change over time

The base for Naming System (namespace of identifiers and code system of local terminologies) is httpsehealthontariocaAPIFHIRNamingSystem For

globalshareable identifiers (eg Ontario health care number Ontario Physician License etc) this might be replaced with httphl7orgfhirNamingSystemca-

on-license-physician in the future when HL7 FHIR Naming System registry is available The base for global identifier namespaces will be referred to as [id-

system-global-base] in the sections and examples below The base for local identifier namespaces (eg placer group number order number etc) will be referred

to as ldquo[id-system-local-base]rdquo in the sections and examples below The base for local code systems (eg test request code) will be referred to as ldquo[code-system-local-

base]rdquo in the sections and examples below

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 7

Variable Value

[base] httpswsgatewayprodehealthontariocaAPIFHIRLaboratoryv1Diagnostic

Report

[base-structure] httpsehealthontariocaAPIFHIRStructureDefinition

[id-system-global-base] httpsehealthontariocaAPIFHIRNamingSystem

[id-system-local-base] httpsehealthontariocaAPIFHIRNamingSystem

[code-system-local-base] httpsehealthontariocaAPIFHIRNamingSystem

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 8

3 Supported Operations

Search Laboratory Report 31

This interaction searches a set of resources based on some filter criteria The interaction can be performed by several different HTTP commands

GET [base][type][parameters]amp_format=[mime-type]

This searches all resources of a particular type using the criteria represented in the parameters

All these search interactions take a series of parameters that are a series of name=value pairs encoded in the URL (See W3C HTML forms)

If the search fails (cannot be executed not that there is no matches) the return value is a status code 4xx or 5xx with an OperationOutcome If the search succeeds

the return content is a Bundle with type = searchset containing the results of the search as a list of resources in a defined order The result list can be long so server

will use paging (adapted from RFC 5005 (Feed Paging and Archiving) for breaking the list into pages if appropriate (see Paging section below) The server may also

return an OperationOutcome resource with additional information about the search

311 Search Parameter Types

Each search parameter is defined by a type that specifies how the search parameter behaves These are the defined parameter types

number Search parameter SHALL be a number (a whole number or a decimal)

date Search parameter is on a datetime The date format is the standard XML format

string Search parameter is a simple string like a name part Search is case-insensitive and accent-insensitive May match just the start of a string String

parameters may contain spaces

token Search parameter on a coded element or identifier May be used to search through the text displayname code and codecodesystem (for codes) and label

system and key (for identifier) Its value is either a string or a pair of namespace and value separated by a | depending on the modifier used

312 Prefixes

For the ordered parameter types of number date and quantity a prefix to the parameter value may be used to control the nature of the matching To avoid URL

escaping and visual confusion the following prefixes are used

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 9

eq the value for the parameter in the resource is equal to the provided value the range of the search value fully contains the range of the target value

gt the value for the parameter in the resource is greater than the provided value the range above the search value intersects (ie overlaps) with the

range of the target value

lt the value for the parameter in the resource is less than the provided value the range below the search value intersects (ie overlaps) with the

range of the target value

ge the value for the parameter in the resource is greater or equal to the provided value the range above the search value intersects (ie overlaps) with the

range of the target value or the range of the search value fully contains

the range of the target value

le the value for the parameter in the resource is less or equal to the provided value the range below the search value intersects (ie overlaps) with the

range of the target value or the range of the search value fully contains

the range of the target value

If no prefix is present the prefix eq is assumed

313 Supported Search Parameters

GET DiagnosticReport (query by Patient ID) o Patient ID parameter patientpatientidentifier

Only Ontario health card number is allowed as an ID parameter in the current release Example patientpatientidentifier=[id-system-global-base]ca-on-patient-hcn|12345678

o Patient Gender parameter gender patientgender Example patientgender=male

o Patient Date of Birth parameter patientbirthdate Example patientbirthdate=19291129

o Dates parameter issuedstart Example issuedstart=ge20160102

314 Search Example

GET [base] DiagnosticReportspatientpatientidentifier=[id-system-global-base]ca-on-patient-hcn| 1008624486amp patientgender=maleamppatientbirthdate=19291129ampissuedstart=ge20160102

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 10

4 FHIR Resources Definitions

General Overview 41

411 Supported Attributes

Only attributes described in the subsections below will be supported

412 Format

OLIS will support JSON and XML formats JSON is the preferred format

Infrastructure Resources 42

421 Resource - Base Resource Definitions

httpwwwhl7orgFHIRresourcehtml Name Card Type ValueVocab Description Comments id 01 id Unique ID set by FHIR server Logical id of this artifact meta 01 Meta Only ldquolastUpdatedrdquo element to be populated

by FHIR server Metadata about the resource

lastUpdated 01 instant This value changes each time the content of the resource changes

language 01 code Used only for Bundle and fixed to ldquoenrdquo in the current release

Language of the resource content

422 DomainResource Resource

httpwwwhl7orgFHIRdomainresourcehtml

A resource with narrative extensions and contained resources

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 11

If a resource is contained in another resource it SHALL NOT have a metaversionId or a metalastUpdated

If the resource is contained in another resource it SHALL be referred to from elsewhere in the resource

If the resource is contained in another resource it SHALL NOT contain nested Resources

If the resource is contained in another resource it SHALL NOT contain any narrative

Most resources are derived from Domain Resources - so they also can contain text contained resources extensions and data elements specific to the particular

domain of the resource

Name Card Type ValueVocab Description Comments text 01 Narrative Text summary of the resource for human

interpretation Not used in the current release

contained 0 Resource Contained inline Resources extension 0 Extension Additional Content defined by

implementations

modifierExtension

0 Extension Extensions that cannot be ignored

423 Bundle Resource

Based on httpwwwhl7orgFHIRbundlehtml

A special type of resource for collections of resources

A set of search results (type = searchset) consists of a series of zero or more entries Each entry element will contain a resource

Bundletotal may be used to return the total number of resources that match the search and that may be returned by following the next link

Name Card Type ValueVocab Description Comments type 11 code Fixed to ldquosearchsetrdquo Type of bundle total 01 unsignedI

nt The total number of matches

link 0 BackboneElement

Links related to this Bundle Optional element might be returned by a server

relation 11 string ldquoselfrdquo for the link to the this Bundle ldquonextrdquo for the link to the next page

ValueSet httpwwwianaorgassignmentslink-relationslink-relationsxhtml

url 11 uri Reference details for the link entry 0 Backbone

Element Entry in the bundle - will have a resource

or information

fullUrl 01 uri The fullUrl element must be present when a resource is present and not present otherwise

Absolute URL for resource (server address or UUIDOID)

resource 01 Resource A resource in the bundle

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 12

424 OperationOutcome Resource

Based on httphl7orgfhiroperationoutcomehtml

Operation Outcomes are sets of error warning and information messages that provide detailed information about the outcome of some attempted system

operation They are provided as a direct system response or component of one where they provide information about the outcome of the operation

OperationOutcomes are used in the following circumstances

When an RESTful operation fails

As the response on a validation operation to provide information about the outcomes

As part of a message response usually when the message has not been processed correctly

This resource is not used for reporting clinical or workflow issues associated with a proposed or ongoing action The resource is not designed to be persisted or

referenced from other parts of the workflow

Name Card

Type ValueVocab Description Comments

issue 1 BackboneElement

A single issue associated with the action

severity 11 code ValueSethttphl7orgfhirvalueset-issue-severityhtml

fatal | error | warning | information

code 11 ValueSethttphl7orgfhirvalueset-issue-typehtml

Error or warning code

details 01 CodeableConcept

ValueSet httphl7orgfhirvalueset-operation-outcomehtml

Additional details about the error

diagnostics 01 string Additional diagnostic information about the issue

location 0 string XPath of element(s) related to issue

425 Using Operation Outcome Resources

On the RESTful interface operation outcome resources are only relevant when a level of computable detail is required that is more granular than that provided by

the HTTP response codes This granularity could include

more detail about the location of an issue

the ability to identify multiple distinct issues

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 13

provision of finer error codes that connect to known business failure states

426 Reporting Errors in the HTTP Headers

Server may also need to report errors in the HTTP headers - especially query parameters when processing searches Errors are reported using a case sensitive

location that has two parts a fixed http and the header or query parameter name separated by a Some examples

Location Description

httpnameexact A reference to the search parameter name with the modifier exact

httpAuthorization A reference to the Authorization header - perhaps to indicate that it is missing and some form of authentication is required

427 OperationOutcome Example - Search

resourceType OperationOutcome

id OperationOutcome1234

issue [

severity fatal

code code-invalid

details

text The name parameter has the modifier exact which is not supported by this server

location [

httpnameexact

]

]

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 14

FHIR Resources 43

DiagnosticReport

PractitionerOrdering Practitioner

Extension ResultCopiestoPractitioners

PatientDiagnosticReportSubject

Organization

PerformingLab

DiagnosticReport

OrganizationReportingLab

ObservationDiagnosticReportResult

SpecimenDiagnosticReportSpecimen

ProcedureRequestDiagnosticReportProcedureRequest

PractitionerAttendingAdmitting

OrganizationExtension

SpecimenCollectorCenter

OrganizationExtension

DestinationLabOrderPlacer

Encounter

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 15

431 Diagnostic Report Profile

ca-on-Diagnostic-DiagnosticReport based on Diagnostic Report profile httphl7orgfhirdiagnosticreporthtml

Name Card Type ValueVocab Description Comments identifier 11 Identifier Identifier assigned by the sending

organization - this is an identifier assigned outside FHIR

This field contains an identifier for the entire order The Placer Group Number is conceptually equivalent to a requisition number assigned to all test requests in an order by an organization (ORC4)

system 11 Uri

The source of the lab reports (ORC43)

value 11 string The unique identifier of the lab report record (ORC41)

status 11 code Value set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

code CodeableConcept

coding 11 coding Fixed code ldquo11502-2rdquo Code defined by a LOINC text 11 string Fixed value ldquoLaboratory Reportrdquo Plain text representation of the concept

Subject (patient)

11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

issued 01 instant dateTime when test request has been issued An instant in time - known at least to the second and always includes a time zone This field will be populated by system (OBR22)

performer 01 Reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

The individual responsible for reporting test result Can be reporting laboratory or reporting practitioner

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 16

Name Card Type ValueVocab Description Comments reference 11 string A reference to a location at which the

other resource is found

request 1 Reference Contained ca-on-Diagnostic-ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

specimen 01 Reference Contained ca-on-Diagnostic-Specimen (Specimen) resource

Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

Result 1 Reference Contained ca-on-Diagnostic-Observation (Observation) resource

List of all the observation associated with the test request (OBX)

reference 11 string A reference to a location at which the other resource is found

codedDiagnosi

s

01 CodeableCon

cept

Value Set ICD10 Diagnosis information

coding 11 coding A reference to a location at which the other resource is found

text 11 string A reference to a location at which the other resource is found

432 Procedure Request Profile

ca-on-Diagnostic-ProcedureRequest profile based on httphl7orgfhirprocedurerequesthtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier assigned by the ordering facility - this is an identifier assigned outside FHIR Must contain a value assigned by the order-placing organization that uniquely identifies this test request among all test requests in OLIS (OBR2)

system 11 Uri The source of test request on the lab report (OBR23)

value 11 string The unique identifier of the test request record (OBR21)

This represents the test request number from the LIS or HIS systems

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 17

Name Card Type ValueVocab Description Comments

status 11 code Value Set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

intent 11 code Value set httphl7orgfhirValueSetrequest-intent

proposal | plan | original-order | order| reflex-order (OBR11)

If OBR11 contains lsquoGrsquo populate lsquoreflex-testrsquo value otherwise fix the value to lsquoOrderrsquo

priority 11 code Value set httphl7orgfhirValueSetrequest-priority

routine | urgent | asap | stat

RequestPriority (Required) (OBR276)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Context (encounter)

11 Reference Contained ca-on-Diagnostic-Encounter (Encounter) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

occuranceDateTime

11 dateTime When testing should occur (OBR274) For routine orders populate this field with the current date

For timing-critical orders populate this field with the date and time that the specimen is to be obtained

For future-dated orders populate this field with the scheduled future date (and time if applicable) when the laboratory test is to occur

extension

01 DateTime of Transaction (ORC9) Populate this field with the

date and time of the event

that initiated the current

transaction

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 18

url 11 httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-dateTime-transaction

valueDateTime 11 dateTime

requester 11 BackboneElement

agent 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the personorganization making request to perform the test (ordering practitionerorganization OBR16)

IF Ordering Facility exists in the message (ORC21) Scenario 1 requester (OBR16) is organization populate ORC21 with the same organization information that in OBR16 field Scenario 2 requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

onBehalfOf 01 reference Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the organization agent is acting for ordering facility

Should be mapped to ordering facility (ORC21 and ORC22) where requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension CCrsquod list practitioner (OBR28) url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-cc-practitioner-list

valueReference (Practitioner)

110 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Practitioners named on an order (attending admitting ccrsquod)

reference 11 string A reference to a location at which the

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 19

other resource is found extension 01 Extension Test Request Placer ZBR2

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-test-request-placer

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Original Test Request Placer

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension Destination Laboratory ZBR8 url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-destination-laboratory

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Destination Laboratory

reference 11 string A reference to a location at which the other resource is found

note 05 Annotation comments authorString 11 string ZNT segment Indicate the organization

(or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

extension 11 Extension Source of Comment (NTE2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-source-comment

valueString

11 string

extension 11 Extension Set ID (NTE1)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 20

set-id

valueString

11 string

433 Observation Profile

ca-on-Diagnostic-Observation profile based on httphl7orgfhirobservationhtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Unique ID for the particular observation (OBR3)

system 11 uri The namespace for the identifier (OBR32) value 11 string The value that is unique (OBR31)

status 11 code Value set Observation result status (OBX11) code CodeableCo

ncept Value set LOINCSNOMED CT

Test result code (OBX3)

coding 11 coding Code defined by a terminology system (OBX31)

text 11 string Plain text representation of the concept (OBX32)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

effective 01 Clinically relevant time for observation

effectiveDateTime

01 dateTime DateTime of observation OBX141 Use this field for ancillary order only

This field must be empty when a laboratory reports a test result

issued 11 instant Indicate the date and time that the Test Result was released by the Reporting Laboratory (ZBX1)

performer (organization)

11 Reference Contained ca-on-Deagnostic-Organization (Organization) Resource or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

The individual responsible for performing the test Can be laboratory or practitioner

reference 11 string A reference to a location at which the other resource is found

value 11 Actual result

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 21

Name Card Type ValueVocab Description Comments

valueQuantity 11 Quantity (OBX2)-Only numeric test value value 11 decimal Numeric value of the test result (OBX5) unit 01 string When observation Value is a scalar value this

field describes the units of measure (OBX61)

interpretation 01 CodebaleConcept

Observation Interpretation Codes(OBX8)

coding 01 Coding Value set method 01 CodebaleCo

ncept How the observation has been done (OBX17)

text 11 string Plain text (OBX172) specimen 01 Reference Contained ca-on-Diagnostic-

Specimen (Specimen) resource Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

referenceRange 01 BackboneElement

Normal range of value associated with observation result (OBX7)

text 11 string Text based reference range in an observation

extension 01 Extension Nature of Abnormal Test (OBX10)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-nature-abnormal-test

valuecoding

11 coding Value set

extension 01 Extension Observation sub-id (OBX4)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation sort key (ZBX2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation comment (NTE-ZNT)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 22

url 11 uri httpehealthontariocaAPIfhir

StructureDefinitiondiagnosticReport-ext-observation-comment

valueAnnotation

11 annotation

authorString

11 string ZNT segment Indicate the organization (or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

434 Specimen Profile

ca-on-Diagnostic-Specimen profile based on httphl7orgfhirspecimenhtml

Name Card Type ValueVocab Description Comments

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

receivedTime 11 dateTime The time when specimen was received for processing

OBR14

request 1 Reference Contained ca-on-Diagnostic- ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

extension 11 Extension Organization that collected the specimen

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-specimen-collector-center

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Specimen Collector Center (ZBR3)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 23

Name Card Type ValueVocab Description Comments

Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

reference 11 string A reference to a location at which the other resource is found

reference 11 string A reference to a location at which the other resource is found

collected 01 Specimen collection time CollectedPeriod 11 Period

start 01 dateTime Starting specimen time OBR7 end 01 dateTime End specimen time OBR8

type 01 CodeableConcept

Kind of material that forms the specimen (Specimen Type)

OBR15

coding 01 coding Value Set from OLIS Code define by the terminology system

OBR1511

text 01 string Plain text representation of the concept

OBR1512

bodySite 01 CodeableConcept

Value Set Anatomical collection site OBR155

container 01 BackboneElement

Direct container of specimen

identifier 02 identifier Id for container OBR18 andor OBR20 Referring Lab User Specimen Identifier and Performing Lab User Specimen Identifier on Refereed ndashout orders

specimenQuantity

01 SimpleQuantity

Quantity of specimen within container

OBR37

note 01 Annotation Collectors comments text 11 string Collectors comments OBR39

extension 01 Extension Collection volume (OBR9)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-collection-volume

valueQuantity

11 Quantity

value 11 decimal Numeric value of the collection OBR91

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 24

volume unit 01 string Units of measure OBR921

435 Patient Profile

ca-on-Diagnostic-Patient profile based on httphl7orgfhirpatienthtml

Name

Card Type ValueVocab Description Comment

identifier

1 Identifier An identifier for this patient

system 11 uri [id-system-global-base]ca-on-patient-hcn

Patient Identifier Assigning Authority Namespace in which set of possible id values is unique (PID391 PID392 PID393)

Value 11 string Patient Identifier Number The portion of the identifier typically displayed to the user and which is unique within the context of the system (PID31)

extension 01 Health Card Version code (PID311) this is an extension patient identifier

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionext-identifier-hcn-version-code

valueString 11 string name

01 HumanName

use 11 code Value set httphl7orgfhirValueSetname-use

Purpose of this name Name type code PID57

Fix to the official for all cases except for anonymous For anonymous code should be lsquoanonymousrsquo

family 11 string Patient Last Name (PID51) given 02 string Patient First Name(PID52) extension 01 patient middle name (PID53)

this is an extension of given name

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode 11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name (PID55)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 25

Name

Card Type ValueVocab Description Comment

suffix 02 String Parts that come after the name (PID54)

extension 01 Patient degree designation This is an extension of suffix

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoACrdquo Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

telecom 03 Demographics Patient table Telephone Number system 01 code httphl7orgfhir

ValueSetcontact-point-system

Telecommunications form for contact point (Phone fax email pager url sms other) PID133 or PID143

Value 11 string The actual contact point details PID134-PID138 Or PID144-PID148

use 01 code httphl7orgfhirValueSetcontact-point-use

Use of contact point (Home work temp old mobile) PID132 or PID142

gender 11 code ldquomalerdquo ldquofemalerdquo ldquootherrdquo ldquounknownrdquo (httphl7orgfhirValueSetadministrative-gender)

The gender of a person used for administrative purposes (PID8)

birthDate 11 date The date of birth for the individual (PID7) Deceased[x]

01 boolean|dateTime

Indicates if the individual is deceased or not The value must be one of the choices specified below but not both System creating instance of this resource must decide which type to use at run time (PID30)

deceasedBoolean

boolean true|false

deceasedDateTime

dateTime Deceased datetime if known (PID29)

address 12 Address Demographics Patient table Address for the individual (PID11)

use 11 code ValueSet httphl7orgfhir

Address Type The use of an address

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 26

Name

Card Type ValueVocab Description Comment

ValueSetaddress-use

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

line 11 string Street lines (PID111) city 11 string Name of city town etc (PID113) state 01 string Province or territory (PID114) postalCode 01 string Postal code for area (PID115) country 11 string Country (can be ISO 3166 3 letter code) (PID116)

436 Practitioner Profile (Ordering Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent Ordering Practitioner information

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR1622

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR161

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR162 given 12 string Practitioner First Name OBR163

extension

01 Practitioner middle name this is an extension of given name

OBR164

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 10: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 7

Variable Value

[base] httpswsgatewayprodehealthontariocaAPIFHIRLaboratoryv1Diagnostic

Report

[base-structure] httpsehealthontariocaAPIFHIRStructureDefinition

[id-system-global-base] httpsehealthontariocaAPIFHIRNamingSystem

[id-system-local-base] httpsehealthontariocaAPIFHIRNamingSystem

[code-system-local-base] httpsehealthontariocaAPIFHIRNamingSystem

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 8

3 Supported Operations

Search Laboratory Report 31

This interaction searches a set of resources based on some filter criteria The interaction can be performed by several different HTTP commands

GET [base][type][parameters]amp_format=[mime-type]

This searches all resources of a particular type using the criteria represented in the parameters

All these search interactions take a series of parameters that are a series of name=value pairs encoded in the URL (See W3C HTML forms)

If the search fails (cannot be executed not that there is no matches) the return value is a status code 4xx or 5xx with an OperationOutcome If the search succeeds

the return content is a Bundle with type = searchset containing the results of the search as a list of resources in a defined order The result list can be long so server

will use paging (adapted from RFC 5005 (Feed Paging and Archiving) for breaking the list into pages if appropriate (see Paging section below) The server may also

return an OperationOutcome resource with additional information about the search

311 Search Parameter Types

Each search parameter is defined by a type that specifies how the search parameter behaves These are the defined parameter types

number Search parameter SHALL be a number (a whole number or a decimal)

date Search parameter is on a datetime The date format is the standard XML format

string Search parameter is a simple string like a name part Search is case-insensitive and accent-insensitive May match just the start of a string String

parameters may contain spaces

token Search parameter on a coded element or identifier May be used to search through the text displayname code and codecodesystem (for codes) and label

system and key (for identifier) Its value is either a string or a pair of namespace and value separated by a | depending on the modifier used

312 Prefixes

For the ordered parameter types of number date and quantity a prefix to the parameter value may be used to control the nature of the matching To avoid URL

escaping and visual confusion the following prefixes are used

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 9

eq the value for the parameter in the resource is equal to the provided value the range of the search value fully contains the range of the target value

gt the value for the parameter in the resource is greater than the provided value the range above the search value intersects (ie overlaps) with the

range of the target value

lt the value for the parameter in the resource is less than the provided value the range below the search value intersects (ie overlaps) with the

range of the target value

ge the value for the parameter in the resource is greater or equal to the provided value the range above the search value intersects (ie overlaps) with the

range of the target value or the range of the search value fully contains

the range of the target value

le the value for the parameter in the resource is less or equal to the provided value the range below the search value intersects (ie overlaps) with the

range of the target value or the range of the search value fully contains

the range of the target value

If no prefix is present the prefix eq is assumed

313 Supported Search Parameters

GET DiagnosticReport (query by Patient ID) o Patient ID parameter patientpatientidentifier

Only Ontario health card number is allowed as an ID parameter in the current release Example patientpatientidentifier=[id-system-global-base]ca-on-patient-hcn|12345678

o Patient Gender parameter gender patientgender Example patientgender=male

o Patient Date of Birth parameter patientbirthdate Example patientbirthdate=19291129

o Dates parameter issuedstart Example issuedstart=ge20160102

314 Search Example

GET [base] DiagnosticReportspatientpatientidentifier=[id-system-global-base]ca-on-patient-hcn| 1008624486amp patientgender=maleamppatientbirthdate=19291129ampissuedstart=ge20160102

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 10

4 FHIR Resources Definitions

General Overview 41

411 Supported Attributes

Only attributes described in the subsections below will be supported

412 Format

OLIS will support JSON and XML formats JSON is the preferred format

Infrastructure Resources 42

421 Resource - Base Resource Definitions

httpwwwhl7orgFHIRresourcehtml Name Card Type ValueVocab Description Comments id 01 id Unique ID set by FHIR server Logical id of this artifact meta 01 Meta Only ldquolastUpdatedrdquo element to be populated

by FHIR server Metadata about the resource

lastUpdated 01 instant This value changes each time the content of the resource changes

language 01 code Used only for Bundle and fixed to ldquoenrdquo in the current release

Language of the resource content

422 DomainResource Resource

httpwwwhl7orgFHIRdomainresourcehtml

A resource with narrative extensions and contained resources

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 11

If a resource is contained in another resource it SHALL NOT have a metaversionId or a metalastUpdated

If the resource is contained in another resource it SHALL be referred to from elsewhere in the resource

If the resource is contained in another resource it SHALL NOT contain nested Resources

If the resource is contained in another resource it SHALL NOT contain any narrative

Most resources are derived from Domain Resources - so they also can contain text contained resources extensions and data elements specific to the particular

domain of the resource

Name Card Type ValueVocab Description Comments text 01 Narrative Text summary of the resource for human

interpretation Not used in the current release

contained 0 Resource Contained inline Resources extension 0 Extension Additional Content defined by

implementations

modifierExtension

0 Extension Extensions that cannot be ignored

423 Bundle Resource

Based on httpwwwhl7orgFHIRbundlehtml

A special type of resource for collections of resources

A set of search results (type = searchset) consists of a series of zero or more entries Each entry element will contain a resource

Bundletotal may be used to return the total number of resources that match the search and that may be returned by following the next link

Name Card Type ValueVocab Description Comments type 11 code Fixed to ldquosearchsetrdquo Type of bundle total 01 unsignedI

nt The total number of matches

link 0 BackboneElement

Links related to this Bundle Optional element might be returned by a server

relation 11 string ldquoselfrdquo for the link to the this Bundle ldquonextrdquo for the link to the next page

ValueSet httpwwwianaorgassignmentslink-relationslink-relationsxhtml

url 11 uri Reference details for the link entry 0 Backbone

Element Entry in the bundle - will have a resource

or information

fullUrl 01 uri The fullUrl element must be present when a resource is present and not present otherwise

Absolute URL for resource (server address or UUIDOID)

resource 01 Resource A resource in the bundle

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 12

424 OperationOutcome Resource

Based on httphl7orgfhiroperationoutcomehtml

Operation Outcomes are sets of error warning and information messages that provide detailed information about the outcome of some attempted system

operation They are provided as a direct system response or component of one where they provide information about the outcome of the operation

OperationOutcomes are used in the following circumstances

When an RESTful operation fails

As the response on a validation operation to provide information about the outcomes

As part of a message response usually when the message has not been processed correctly

This resource is not used for reporting clinical or workflow issues associated with a proposed or ongoing action The resource is not designed to be persisted or

referenced from other parts of the workflow

Name Card

Type ValueVocab Description Comments

issue 1 BackboneElement

A single issue associated with the action

severity 11 code ValueSethttphl7orgfhirvalueset-issue-severityhtml

fatal | error | warning | information

code 11 ValueSethttphl7orgfhirvalueset-issue-typehtml

Error or warning code

details 01 CodeableConcept

ValueSet httphl7orgfhirvalueset-operation-outcomehtml

Additional details about the error

diagnostics 01 string Additional diagnostic information about the issue

location 0 string XPath of element(s) related to issue

425 Using Operation Outcome Resources

On the RESTful interface operation outcome resources are only relevant when a level of computable detail is required that is more granular than that provided by

the HTTP response codes This granularity could include

more detail about the location of an issue

the ability to identify multiple distinct issues

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 13

provision of finer error codes that connect to known business failure states

426 Reporting Errors in the HTTP Headers

Server may also need to report errors in the HTTP headers - especially query parameters when processing searches Errors are reported using a case sensitive

location that has two parts a fixed http and the header or query parameter name separated by a Some examples

Location Description

httpnameexact A reference to the search parameter name with the modifier exact

httpAuthorization A reference to the Authorization header - perhaps to indicate that it is missing and some form of authentication is required

427 OperationOutcome Example - Search

resourceType OperationOutcome

id OperationOutcome1234

issue [

severity fatal

code code-invalid

details

text The name parameter has the modifier exact which is not supported by this server

location [

httpnameexact

]

]

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 14

FHIR Resources 43

DiagnosticReport

PractitionerOrdering Practitioner

Extension ResultCopiestoPractitioners

PatientDiagnosticReportSubject

Organization

PerformingLab

DiagnosticReport

OrganizationReportingLab

ObservationDiagnosticReportResult

SpecimenDiagnosticReportSpecimen

ProcedureRequestDiagnosticReportProcedureRequest

PractitionerAttendingAdmitting

OrganizationExtension

SpecimenCollectorCenter

OrganizationExtension

DestinationLabOrderPlacer

Encounter

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 15

431 Diagnostic Report Profile

ca-on-Diagnostic-DiagnosticReport based on Diagnostic Report profile httphl7orgfhirdiagnosticreporthtml

Name Card Type ValueVocab Description Comments identifier 11 Identifier Identifier assigned by the sending

organization - this is an identifier assigned outside FHIR

This field contains an identifier for the entire order The Placer Group Number is conceptually equivalent to a requisition number assigned to all test requests in an order by an organization (ORC4)

system 11 Uri

The source of the lab reports (ORC43)

value 11 string The unique identifier of the lab report record (ORC41)

status 11 code Value set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

code CodeableConcept

coding 11 coding Fixed code ldquo11502-2rdquo Code defined by a LOINC text 11 string Fixed value ldquoLaboratory Reportrdquo Plain text representation of the concept

Subject (patient)

11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

issued 01 instant dateTime when test request has been issued An instant in time - known at least to the second and always includes a time zone This field will be populated by system (OBR22)

performer 01 Reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

The individual responsible for reporting test result Can be reporting laboratory or reporting practitioner

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 16

Name Card Type ValueVocab Description Comments reference 11 string A reference to a location at which the

other resource is found

request 1 Reference Contained ca-on-Diagnostic-ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

specimen 01 Reference Contained ca-on-Diagnostic-Specimen (Specimen) resource

Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

Result 1 Reference Contained ca-on-Diagnostic-Observation (Observation) resource

List of all the observation associated with the test request (OBX)

reference 11 string A reference to a location at which the other resource is found

codedDiagnosi

s

01 CodeableCon

cept

Value Set ICD10 Diagnosis information

coding 11 coding A reference to a location at which the other resource is found

text 11 string A reference to a location at which the other resource is found

432 Procedure Request Profile

ca-on-Diagnostic-ProcedureRequest profile based on httphl7orgfhirprocedurerequesthtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier assigned by the ordering facility - this is an identifier assigned outside FHIR Must contain a value assigned by the order-placing organization that uniquely identifies this test request among all test requests in OLIS (OBR2)

system 11 Uri The source of test request on the lab report (OBR23)

value 11 string The unique identifier of the test request record (OBR21)

This represents the test request number from the LIS or HIS systems

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 17

Name Card Type ValueVocab Description Comments

status 11 code Value Set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

intent 11 code Value set httphl7orgfhirValueSetrequest-intent

proposal | plan | original-order | order| reflex-order (OBR11)

If OBR11 contains lsquoGrsquo populate lsquoreflex-testrsquo value otherwise fix the value to lsquoOrderrsquo

priority 11 code Value set httphl7orgfhirValueSetrequest-priority

routine | urgent | asap | stat

RequestPriority (Required) (OBR276)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Context (encounter)

11 Reference Contained ca-on-Diagnostic-Encounter (Encounter) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

occuranceDateTime

11 dateTime When testing should occur (OBR274) For routine orders populate this field with the current date

For timing-critical orders populate this field with the date and time that the specimen is to be obtained

For future-dated orders populate this field with the scheduled future date (and time if applicable) when the laboratory test is to occur

extension

01 DateTime of Transaction (ORC9) Populate this field with the

date and time of the event

that initiated the current

transaction

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 18

url 11 httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-dateTime-transaction

valueDateTime 11 dateTime

requester 11 BackboneElement

agent 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the personorganization making request to perform the test (ordering practitionerorganization OBR16)

IF Ordering Facility exists in the message (ORC21) Scenario 1 requester (OBR16) is organization populate ORC21 with the same organization information that in OBR16 field Scenario 2 requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

onBehalfOf 01 reference Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the organization agent is acting for ordering facility

Should be mapped to ordering facility (ORC21 and ORC22) where requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension CCrsquod list practitioner (OBR28) url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-cc-practitioner-list

valueReference (Practitioner)

110 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Practitioners named on an order (attending admitting ccrsquod)

reference 11 string A reference to a location at which the

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 19

other resource is found extension 01 Extension Test Request Placer ZBR2

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-test-request-placer

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Original Test Request Placer

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension Destination Laboratory ZBR8 url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-destination-laboratory

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Destination Laboratory

reference 11 string A reference to a location at which the other resource is found

note 05 Annotation comments authorString 11 string ZNT segment Indicate the organization

(or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

extension 11 Extension Source of Comment (NTE2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-source-comment

valueString

11 string

extension 11 Extension Set ID (NTE1)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 20

set-id

valueString

11 string

433 Observation Profile

ca-on-Diagnostic-Observation profile based on httphl7orgfhirobservationhtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Unique ID for the particular observation (OBR3)

system 11 uri The namespace for the identifier (OBR32) value 11 string The value that is unique (OBR31)

status 11 code Value set Observation result status (OBX11) code CodeableCo

ncept Value set LOINCSNOMED CT

Test result code (OBX3)

coding 11 coding Code defined by a terminology system (OBX31)

text 11 string Plain text representation of the concept (OBX32)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

effective 01 Clinically relevant time for observation

effectiveDateTime

01 dateTime DateTime of observation OBX141 Use this field for ancillary order only

This field must be empty when a laboratory reports a test result

issued 11 instant Indicate the date and time that the Test Result was released by the Reporting Laboratory (ZBX1)

performer (organization)

11 Reference Contained ca-on-Deagnostic-Organization (Organization) Resource or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

The individual responsible for performing the test Can be laboratory or practitioner

reference 11 string A reference to a location at which the other resource is found

value 11 Actual result

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 21

Name Card Type ValueVocab Description Comments

valueQuantity 11 Quantity (OBX2)-Only numeric test value value 11 decimal Numeric value of the test result (OBX5) unit 01 string When observation Value is a scalar value this

field describes the units of measure (OBX61)

interpretation 01 CodebaleConcept

Observation Interpretation Codes(OBX8)

coding 01 Coding Value set method 01 CodebaleCo

ncept How the observation has been done (OBX17)

text 11 string Plain text (OBX172) specimen 01 Reference Contained ca-on-Diagnostic-

Specimen (Specimen) resource Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

referenceRange 01 BackboneElement

Normal range of value associated with observation result (OBX7)

text 11 string Text based reference range in an observation

extension 01 Extension Nature of Abnormal Test (OBX10)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-nature-abnormal-test

valuecoding

11 coding Value set

extension 01 Extension Observation sub-id (OBX4)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation sort key (ZBX2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation comment (NTE-ZNT)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 22

url 11 uri httpehealthontariocaAPIfhir

StructureDefinitiondiagnosticReport-ext-observation-comment

valueAnnotation

11 annotation

authorString

11 string ZNT segment Indicate the organization (or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

434 Specimen Profile

ca-on-Diagnostic-Specimen profile based on httphl7orgfhirspecimenhtml

Name Card Type ValueVocab Description Comments

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

receivedTime 11 dateTime The time when specimen was received for processing

OBR14

request 1 Reference Contained ca-on-Diagnostic- ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

extension 11 Extension Organization that collected the specimen

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-specimen-collector-center

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Specimen Collector Center (ZBR3)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 23

Name Card Type ValueVocab Description Comments

Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

reference 11 string A reference to a location at which the other resource is found

reference 11 string A reference to a location at which the other resource is found

collected 01 Specimen collection time CollectedPeriod 11 Period

start 01 dateTime Starting specimen time OBR7 end 01 dateTime End specimen time OBR8

type 01 CodeableConcept

Kind of material that forms the specimen (Specimen Type)

OBR15

coding 01 coding Value Set from OLIS Code define by the terminology system

OBR1511

text 01 string Plain text representation of the concept

OBR1512

bodySite 01 CodeableConcept

Value Set Anatomical collection site OBR155

container 01 BackboneElement

Direct container of specimen

identifier 02 identifier Id for container OBR18 andor OBR20 Referring Lab User Specimen Identifier and Performing Lab User Specimen Identifier on Refereed ndashout orders

specimenQuantity

01 SimpleQuantity

Quantity of specimen within container

OBR37

note 01 Annotation Collectors comments text 11 string Collectors comments OBR39

extension 01 Extension Collection volume (OBR9)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-collection-volume

valueQuantity

11 Quantity

value 11 decimal Numeric value of the collection OBR91

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 24

volume unit 01 string Units of measure OBR921

435 Patient Profile

ca-on-Diagnostic-Patient profile based on httphl7orgfhirpatienthtml

Name

Card Type ValueVocab Description Comment

identifier

1 Identifier An identifier for this patient

system 11 uri [id-system-global-base]ca-on-patient-hcn

Patient Identifier Assigning Authority Namespace in which set of possible id values is unique (PID391 PID392 PID393)

Value 11 string Patient Identifier Number The portion of the identifier typically displayed to the user and which is unique within the context of the system (PID31)

extension 01 Health Card Version code (PID311) this is an extension patient identifier

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionext-identifier-hcn-version-code

valueString 11 string name

01 HumanName

use 11 code Value set httphl7orgfhirValueSetname-use

Purpose of this name Name type code PID57

Fix to the official for all cases except for anonymous For anonymous code should be lsquoanonymousrsquo

family 11 string Patient Last Name (PID51) given 02 string Patient First Name(PID52) extension 01 patient middle name (PID53)

this is an extension of given name

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode 11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name (PID55)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 25

Name

Card Type ValueVocab Description Comment

suffix 02 String Parts that come after the name (PID54)

extension 01 Patient degree designation This is an extension of suffix

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoACrdquo Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

telecom 03 Demographics Patient table Telephone Number system 01 code httphl7orgfhir

ValueSetcontact-point-system

Telecommunications form for contact point (Phone fax email pager url sms other) PID133 or PID143

Value 11 string The actual contact point details PID134-PID138 Or PID144-PID148

use 01 code httphl7orgfhirValueSetcontact-point-use

Use of contact point (Home work temp old mobile) PID132 or PID142

gender 11 code ldquomalerdquo ldquofemalerdquo ldquootherrdquo ldquounknownrdquo (httphl7orgfhirValueSetadministrative-gender)

The gender of a person used for administrative purposes (PID8)

birthDate 11 date The date of birth for the individual (PID7) Deceased[x]

01 boolean|dateTime

Indicates if the individual is deceased or not The value must be one of the choices specified below but not both System creating instance of this resource must decide which type to use at run time (PID30)

deceasedBoolean

boolean true|false

deceasedDateTime

dateTime Deceased datetime if known (PID29)

address 12 Address Demographics Patient table Address for the individual (PID11)

use 11 code ValueSet httphl7orgfhir

Address Type The use of an address

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 26

Name

Card Type ValueVocab Description Comment

ValueSetaddress-use

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

line 11 string Street lines (PID111) city 11 string Name of city town etc (PID113) state 01 string Province or territory (PID114) postalCode 01 string Postal code for area (PID115) country 11 string Country (can be ISO 3166 3 letter code) (PID116)

436 Practitioner Profile (Ordering Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent Ordering Practitioner information

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR1622

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR161

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR162 given 12 string Practitioner First Name OBR163

extension

01 Practitioner middle name this is an extension of given name

OBR164

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 11: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 8

3 Supported Operations

Search Laboratory Report 31

This interaction searches a set of resources based on some filter criteria The interaction can be performed by several different HTTP commands

GET [base][type][parameters]amp_format=[mime-type]

This searches all resources of a particular type using the criteria represented in the parameters

All these search interactions take a series of parameters that are a series of name=value pairs encoded in the URL (See W3C HTML forms)

If the search fails (cannot be executed not that there is no matches) the return value is a status code 4xx or 5xx with an OperationOutcome If the search succeeds

the return content is a Bundle with type = searchset containing the results of the search as a list of resources in a defined order The result list can be long so server

will use paging (adapted from RFC 5005 (Feed Paging and Archiving) for breaking the list into pages if appropriate (see Paging section below) The server may also

return an OperationOutcome resource with additional information about the search

311 Search Parameter Types

Each search parameter is defined by a type that specifies how the search parameter behaves These are the defined parameter types

number Search parameter SHALL be a number (a whole number or a decimal)

date Search parameter is on a datetime The date format is the standard XML format

string Search parameter is a simple string like a name part Search is case-insensitive and accent-insensitive May match just the start of a string String

parameters may contain spaces

token Search parameter on a coded element or identifier May be used to search through the text displayname code and codecodesystem (for codes) and label

system and key (for identifier) Its value is either a string or a pair of namespace and value separated by a | depending on the modifier used

312 Prefixes

For the ordered parameter types of number date and quantity a prefix to the parameter value may be used to control the nature of the matching To avoid URL

escaping and visual confusion the following prefixes are used

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 9

eq the value for the parameter in the resource is equal to the provided value the range of the search value fully contains the range of the target value

gt the value for the parameter in the resource is greater than the provided value the range above the search value intersects (ie overlaps) with the

range of the target value

lt the value for the parameter in the resource is less than the provided value the range below the search value intersects (ie overlaps) with the

range of the target value

ge the value for the parameter in the resource is greater or equal to the provided value the range above the search value intersects (ie overlaps) with the

range of the target value or the range of the search value fully contains

the range of the target value

le the value for the parameter in the resource is less or equal to the provided value the range below the search value intersects (ie overlaps) with the

range of the target value or the range of the search value fully contains

the range of the target value

If no prefix is present the prefix eq is assumed

313 Supported Search Parameters

GET DiagnosticReport (query by Patient ID) o Patient ID parameter patientpatientidentifier

Only Ontario health card number is allowed as an ID parameter in the current release Example patientpatientidentifier=[id-system-global-base]ca-on-patient-hcn|12345678

o Patient Gender parameter gender patientgender Example patientgender=male

o Patient Date of Birth parameter patientbirthdate Example patientbirthdate=19291129

o Dates parameter issuedstart Example issuedstart=ge20160102

314 Search Example

GET [base] DiagnosticReportspatientpatientidentifier=[id-system-global-base]ca-on-patient-hcn| 1008624486amp patientgender=maleamppatientbirthdate=19291129ampissuedstart=ge20160102

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 10

4 FHIR Resources Definitions

General Overview 41

411 Supported Attributes

Only attributes described in the subsections below will be supported

412 Format

OLIS will support JSON and XML formats JSON is the preferred format

Infrastructure Resources 42

421 Resource - Base Resource Definitions

httpwwwhl7orgFHIRresourcehtml Name Card Type ValueVocab Description Comments id 01 id Unique ID set by FHIR server Logical id of this artifact meta 01 Meta Only ldquolastUpdatedrdquo element to be populated

by FHIR server Metadata about the resource

lastUpdated 01 instant This value changes each time the content of the resource changes

language 01 code Used only for Bundle and fixed to ldquoenrdquo in the current release

Language of the resource content

422 DomainResource Resource

httpwwwhl7orgFHIRdomainresourcehtml

A resource with narrative extensions and contained resources

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 11

If a resource is contained in another resource it SHALL NOT have a metaversionId or a metalastUpdated

If the resource is contained in another resource it SHALL be referred to from elsewhere in the resource

If the resource is contained in another resource it SHALL NOT contain nested Resources

If the resource is contained in another resource it SHALL NOT contain any narrative

Most resources are derived from Domain Resources - so they also can contain text contained resources extensions and data elements specific to the particular

domain of the resource

Name Card Type ValueVocab Description Comments text 01 Narrative Text summary of the resource for human

interpretation Not used in the current release

contained 0 Resource Contained inline Resources extension 0 Extension Additional Content defined by

implementations

modifierExtension

0 Extension Extensions that cannot be ignored

423 Bundle Resource

Based on httpwwwhl7orgFHIRbundlehtml

A special type of resource for collections of resources

A set of search results (type = searchset) consists of a series of zero or more entries Each entry element will contain a resource

Bundletotal may be used to return the total number of resources that match the search and that may be returned by following the next link

Name Card Type ValueVocab Description Comments type 11 code Fixed to ldquosearchsetrdquo Type of bundle total 01 unsignedI

nt The total number of matches

link 0 BackboneElement

Links related to this Bundle Optional element might be returned by a server

relation 11 string ldquoselfrdquo for the link to the this Bundle ldquonextrdquo for the link to the next page

ValueSet httpwwwianaorgassignmentslink-relationslink-relationsxhtml

url 11 uri Reference details for the link entry 0 Backbone

Element Entry in the bundle - will have a resource

or information

fullUrl 01 uri The fullUrl element must be present when a resource is present and not present otherwise

Absolute URL for resource (server address or UUIDOID)

resource 01 Resource A resource in the bundle

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 12

424 OperationOutcome Resource

Based on httphl7orgfhiroperationoutcomehtml

Operation Outcomes are sets of error warning and information messages that provide detailed information about the outcome of some attempted system

operation They are provided as a direct system response or component of one where they provide information about the outcome of the operation

OperationOutcomes are used in the following circumstances

When an RESTful operation fails

As the response on a validation operation to provide information about the outcomes

As part of a message response usually when the message has not been processed correctly

This resource is not used for reporting clinical or workflow issues associated with a proposed or ongoing action The resource is not designed to be persisted or

referenced from other parts of the workflow

Name Card

Type ValueVocab Description Comments

issue 1 BackboneElement

A single issue associated with the action

severity 11 code ValueSethttphl7orgfhirvalueset-issue-severityhtml

fatal | error | warning | information

code 11 ValueSethttphl7orgfhirvalueset-issue-typehtml

Error or warning code

details 01 CodeableConcept

ValueSet httphl7orgfhirvalueset-operation-outcomehtml

Additional details about the error

diagnostics 01 string Additional diagnostic information about the issue

location 0 string XPath of element(s) related to issue

425 Using Operation Outcome Resources

On the RESTful interface operation outcome resources are only relevant when a level of computable detail is required that is more granular than that provided by

the HTTP response codes This granularity could include

more detail about the location of an issue

the ability to identify multiple distinct issues

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 13

provision of finer error codes that connect to known business failure states

426 Reporting Errors in the HTTP Headers

Server may also need to report errors in the HTTP headers - especially query parameters when processing searches Errors are reported using a case sensitive

location that has two parts a fixed http and the header or query parameter name separated by a Some examples

Location Description

httpnameexact A reference to the search parameter name with the modifier exact

httpAuthorization A reference to the Authorization header - perhaps to indicate that it is missing and some form of authentication is required

427 OperationOutcome Example - Search

resourceType OperationOutcome

id OperationOutcome1234

issue [

severity fatal

code code-invalid

details

text The name parameter has the modifier exact which is not supported by this server

location [

httpnameexact

]

]

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 14

FHIR Resources 43

DiagnosticReport

PractitionerOrdering Practitioner

Extension ResultCopiestoPractitioners

PatientDiagnosticReportSubject

Organization

PerformingLab

DiagnosticReport

OrganizationReportingLab

ObservationDiagnosticReportResult

SpecimenDiagnosticReportSpecimen

ProcedureRequestDiagnosticReportProcedureRequest

PractitionerAttendingAdmitting

OrganizationExtension

SpecimenCollectorCenter

OrganizationExtension

DestinationLabOrderPlacer

Encounter

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 15

431 Diagnostic Report Profile

ca-on-Diagnostic-DiagnosticReport based on Diagnostic Report profile httphl7orgfhirdiagnosticreporthtml

Name Card Type ValueVocab Description Comments identifier 11 Identifier Identifier assigned by the sending

organization - this is an identifier assigned outside FHIR

This field contains an identifier for the entire order The Placer Group Number is conceptually equivalent to a requisition number assigned to all test requests in an order by an organization (ORC4)

system 11 Uri

The source of the lab reports (ORC43)

value 11 string The unique identifier of the lab report record (ORC41)

status 11 code Value set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

code CodeableConcept

coding 11 coding Fixed code ldquo11502-2rdquo Code defined by a LOINC text 11 string Fixed value ldquoLaboratory Reportrdquo Plain text representation of the concept

Subject (patient)

11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

issued 01 instant dateTime when test request has been issued An instant in time - known at least to the second and always includes a time zone This field will be populated by system (OBR22)

performer 01 Reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

The individual responsible for reporting test result Can be reporting laboratory or reporting practitioner

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 16

Name Card Type ValueVocab Description Comments reference 11 string A reference to a location at which the

other resource is found

request 1 Reference Contained ca-on-Diagnostic-ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

specimen 01 Reference Contained ca-on-Diagnostic-Specimen (Specimen) resource

Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

Result 1 Reference Contained ca-on-Diagnostic-Observation (Observation) resource

List of all the observation associated with the test request (OBX)

reference 11 string A reference to a location at which the other resource is found

codedDiagnosi

s

01 CodeableCon

cept

Value Set ICD10 Diagnosis information

coding 11 coding A reference to a location at which the other resource is found

text 11 string A reference to a location at which the other resource is found

432 Procedure Request Profile

ca-on-Diagnostic-ProcedureRequest profile based on httphl7orgfhirprocedurerequesthtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier assigned by the ordering facility - this is an identifier assigned outside FHIR Must contain a value assigned by the order-placing organization that uniquely identifies this test request among all test requests in OLIS (OBR2)

system 11 Uri The source of test request on the lab report (OBR23)

value 11 string The unique identifier of the test request record (OBR21)

This represents the test request number from the LIS or HIS systems

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 17

Name Card Type ValueVocab Description Comments

status 11 code Value Set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

intent 11 code Value set httphl7orgfhirValueSetrequest-intent

proposal | plan | original-order | order| reflex-order (OBR11)

If OBR11 contains lsquoGrsquo populate lsquoreflex-testrsquo value otherwise fix the value to lsquoOrderrsquo

priority 11 code Value set httphl7orgfhirValueSetrequest-priority

routine | urgent | asap | stat

RequestPriority (Required) (OBR276)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Context (encounter)

11 Reference Contained ca-on-Diagnostic-Encounter (Encounter) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

occuranceDateTime

11 dateTime When testing should occur (OBR274) For routine orders populate this field with the current date

For timing-critical orders populate this field with the date and time that the specimen is to be obtained

For future-dated orders populate this field with the scheduled future date (and time if applicable) when the laboratory test is to occur

extension

01 DateTime of Transaction (ORC9) Populate this field with the

date and time of the event

that initiated the current

transaction

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 18

url 11 httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-dateTime-transaction

valueDateTime 11 dateTime

requester 11 BackboneElement

agent 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the personorganization making request to perform the test (ordering practitionerorganization OBR16)

IF Ordering Facility exists in the message (ORC21) Scenario 1 requester (OBR16) is organization populate ORC21 with the same organization information that in OBR16 field Scenario 2 requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

onBehalfOf 01 reference Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the organization agent is acting for ordering facility

Should be mapped to ordering facility (ORC21 and ORC22) where requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension CCrsquod list practitioner (OBR28) url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-cc-practitioner-list

valueReference (Practitioner)

110 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Practitioners named on an order (attending admitting ccrsquod)

reference 11 string A reference to a location at which the

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 19

other resource is found extension 01 Extension Test Request Placer ZBR2

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-test-request-placer

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Original Test Request Placer

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension Destination Laboratory ZBR8 url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-destination-laboratory

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Destination Laboratory

reference 11 string A reference to a location at which the other resource is found

note 05 Annotation comments authorString 11 string ZNT segment Indicate the organization

(or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

extension 11 Extension Source of Comment (NTE2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-source-comment

valueString

11 string

extension 11 Extension Set ID (NTE1)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 20

set-id

valueString

11 string

433 Observation Profile

ca-on-Diagnostic-Observation profile based on httphl7orgfhirobservationhtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Unique ID for the particular observation (OBR3)

system 11 uri The namespace for the identifier (OBR32) value 11 string The value that is unique (OBR31)

status 11 code Value set Observation result status (OBX11) code CodeableCo

ncept Value set LOINCSNOMED CT

Test result code (OBX3)

coding 11 coding Code defined by a terminology system (OBX31)

text 11 string Plain text representation of the concept (OBX32)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

effective 01 Clinically relevant time for observation

effectiveDateTime

01 dateTime DateTime of observation OBX141 Use this field for ancillary order only

This field must be empty when a laboratory reports a test result

issued 11 instant Indicate the date and time that the Test Result was released by the Reporting Laboratory (ZBX1)

performer (organization)

11 Reference Contained ca-on-Deagnostic-Organization (Organization) Resource or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

The individual responsible for performing the test Can be laboratory or practitioner

reference 11 string A reference to a location at which the other resource is found

value 11 Actual result

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 21

Name Card Type ValueVocab Description Comments

valueQuantity 11 Quantity (OBX2)-Only numeric test value value 11 decimal Numeric value of the test result (OBX5) unit 01 string When observation Value is a scalar value this

field describes the units of measure (OBX61)

interpretation 01 CodebaleConcept

Observation Interpretation Codes(OBX8)

coding 01 Coding Value set method 01 CodebaleCo

ncept How the observation has been done (OBX17)

text 11 string Plain text (OBX172) specimen 01 Reference Contained ca-on-Diagnostic-

Specimen (Specimen) resource Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

referenceRange 01 BackboneElement

Normal range of value associated with observation result (OBX7)

text 11 string Text based reference range in an observation

extension 01 Extension Nature of Abnormal Test (OBX10)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-nature-abnormal-test

valuecoding

11 coding Value set

extension 01 Extension Observation sub-id (OBX4)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation sort key (ZBX2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation comment (NTE-ZNT)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 22

url 11 uri httpehealthontariocaAPIfhir

StructureDefinitiondiagnosticReport-ext-observation-comment

valueAnnotation

11 annotation

authorString

11 string ZNT segment Indicate the organization (or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

434 Specimen Profile

ca-on-Diagnostic-Specimen profile based on httphl7orgfhirspecimenhtml

Name Card Type ValueVocab Description Comments

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

receivedTime 11 dateTime The time when specimen was received for processing

OBR14

request 1 Reference Contained ca-on-Diagnostic- ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

extension 11 Extension Organization that collected the specimen

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-specimen-collector-center

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Specimen Collector Center (ZBR3)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 23

Name Card Type ValueVocab Description Comments

Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

reference 11 string A reference to a location at which the other resource is found

reference 11 string A reference to a location at which the other resource is found

collected 01 Specimen collection time CollectedPeriod 11 Period

start 01 dateTime Starting specimen time OBR7 end 01 dateTime End specimen time OBR8

type 01 CodeableConcept

Kind of material that forms the specimen (Specimen Type)

OBR15

coding 01 coding Value Set from OLIS Code define by the terminology system

OBR1511

text 01 string Plain text representation of the concept

OBR1512

bodySite 01 CodeableConcept

Value Set Anatomical collection site OBR155

container 01 BackboneElement

Direct container of specimen

identifier 02 identifier Id for container OBR18 andor OBR20 Referring Lab User Specimen Identifier and Performing Lab User Specimen Identifier on Refereed ndashout orders

specimenQuantity

01 SimpleQuantity

Quantity of specimen within container

OBR37

note 01 Annotation Collectors comments text 11 string Collectors comments OBR39

extension 01 Extension Collection volume (OBR9)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-collection-volume

valueQuantity

11 Quantity

value 11 decimal Numeric value of the collection OBR91

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 24

volume unit 01 string Units of measure OBR921

435 Patient Profile

ca-on-Diagnostic-Patient profile based on httphl7orgfhirpatienthtml

Name

Card Type ValueVocab Description Comment

identifier

1 Identifier An identifier for this patient

system 11 uri [id-system-global-base]ca-on-patient-hcn

Patient Identifier Assigning Authority Namespace in which set of possible id values is unique (PID391 PID392 PID393)

Value 11 string Patient Identifier Number The portion of the identifier typically displayed to the user and which is unique within the context of the system (PID31)

extension 01 Health Card Version code (PID311) this is an extension patient identifier

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionext-identifier-hcn-version-code

valueString 11 string name

01 HumanName

use 11 code Value set httphl7orgfhirValueSetname-use

Purpose of this name Name type code PID57

Fix to the official for all cases except for anonymous For anonymous code should be lsquoanonymousrsquo

family 11 string Patient Last Name (PID51) given 02 string Patient First Name(PID52) extension 01 patient middle name (PID53)

this is an extension of given name

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode 11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name (PID55)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 25

Name

Card Type ValueVocab Description Comment

suffix 02 String Parts that come after the name (PID54)

extension 01 Patient degree designation This is an extension of suffix

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoACrdquo Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

telecom 03 Demographics Patient table Telephone Number system 01 code httphl7orgfhir

ValueSetcontact-point-system

Telecommunications form for contact point (Phone fax email pager url sms other) PID133 or PID143

Value 11 string The actual contact point details PID134-PID138 Or PID144-PID148

use 01 code httphl7orgfhirValueSetcontact-point-use

Use of contact point (Home work temp old mobile) PID132 or PID142

gender 11 code ldquomalerdquo ldquofemalerdquo ldquootherrdquo ldquounknownrdquo (httphl7orgfhirValueSetadministrative-gender)

The gender of a person used for administrative purposes (PID8)

birthDate 11 date The date of birth for the individual (PID7) Deceased[x]

01 boolean|dateTime

Indicates if the individual is deceased or not The value must be one of the choices specified below but not both System creating instance of this resource must decide which type to use at run time (PID30)

deceasedBoolean

boolean true|false

deceasedDateTime

dateTime Deceased datetime if known (PID29)

address 12 Address Demographics Patient table Address for the individual (PID11)

use 11 code ValueSet httphl7orgfhir

Address Type The use of an address

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 26

Name

Card Type ValueVocab Description Comment

ValueSetaddress-use

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

line 11 string Street lines (PID111) city 11 string Name of city town etc (PID113) state 01 string Province or territory (PID114) postalCode 01 string Postal code for area (PID115) country 11 string Country (can be ISO 3166 3 letter code) (PID116)

436 Practitioner Profile (Ordering Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent Ordering Practitioner information

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR1622

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR161

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR162 given 12 string Practitioner First Name OBR163

extension

01 Practitioner middle name this is an extension of given name

OBR164

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 12: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 9

eq the value for the parameter in the resource is equal to the provided value the range of the search value fully contains the range of the target value

gt the value for the parameter in the resource is greater than the provided value the range above the search value intersects (ie overlaps) with the

range of the target value

lt the value for the parameter in the resource is less than the provided value the range below the search value intersects (ie overlaps) with the

range of the target value

ge the value for the parameter in the resource is greater or equal to the provided value the range above the search value intersects (ie overlaps) with the

range of the target value or the range of the search value fully contains

the range of the target value

le the value for the parameter in the resource is less or equal to the provided value the range below the search value intersects (ie overlaps) with the

range of the target value or the range of the search value fully contains

the range of the target value

If no prefix is present the prefix eq is assumed

313 Supported Search Parameters

GET DiagnosticReport (query by Patient ID) o Patient ID parameter patientpatientidentifier

Only Ontario health card number is allowed as an ID parameter in the current release Example patientpatientidentifier=[id-system-global-base]ca-on-patient-hcn|12345678

o Patient Gender parameter gender patientgender Example patientgender=male

o Patient Date of Birth parameter patientbirthdate Example patientbirthdate=19291129

o Dates parameter issuedstart Example issuedstart=ge20160102

314 Search Example

GET [base] DiagnosticReportspatientpatientidentifier=[id-system-global-base]ca-on-patient-hcn| 1008624486amp patientgender=maleamppatientbirthdate=19291129ampissuedstart=ge20160102

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 10

4 FHIR Resources Definitions

General Overview 41

411 Supported Attributes

Only attributes described in the subsections below will be supported

412 Format

OLIS will support JSON and XML formats JSON is the preferred format

Infrastructure Resources 42

421 Resource - Base Resource Definitions

httpwwwhl7orgFHIRresourcehtml Name Card Type ValueVocab Description Comments id 01 id Unique ID set by FHIR server Logical id of this artifact meta 01 Meta Only ldquolastUpdatedrdquo element to be populated

by FHIR server Metadata about the resource

lastUpdated 01 instant This value changes each time the content of the resource changes

language 01 code Used only for Bundle and fixed to ldquoenrdquo in the current release

Language of the resource content

422 DomainResource Resource

httpwwwhl7orgFHIRdomainresourcehtml

A resource with narrative extensions and contained resources

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 11

If a resource is contained in another resource it SHALL NOT have a metaversionId or a metalastUpdated

If the resource is contained in another resource it SHALL be referred to from elsewhere in the resource

If the resource is contained in another resource it SHALL NOT contain nested Resources

If the resource is contained in another resource it SHALL NOT contain any narrative

Most resources are derived from Domain Resources - so they also can contain text contained resources extensions and data elements specific to the particular

domain of the resource

Name Card Type ValueVocab Description Comments text 01 Narrative Text summary of the resource for human

interpretation Not used in the current release

contained 0 Resource Contained inline Resources extension 0 Extension Additional Content defined by

implementations

modifierExtension

0 Extension Extensions that cannot be ignored

423 Bundle Resource

Based on httpwwwhl7orgFHIRbundlehtml

A special type of resource for collections of resources

A set of search results (type = searchset) consists of a series of zero or more entries Each entry element will contain a resource

Bundletotal may be used to return the total number of resources that match the search and that may be returned by following the next link

Name Card Type ValueVocab Description Comments type 11 code Fixed to ldquosearchsetrdquo Type of bundle total 01 unsignedI

nt The total number of matches

link 0 BackboneElement

Links related to this Bundle Optional element might be returned by a server

relation 11 string ldquoselfrdquo for the link to the this Bundle ldquonextrdquo for the link to the next page

ValueSet httpwwwianaorgassignmentslink-relationslink-relationsxhtml

url 11 uri Reference details for the link entry 0 Backbone

Element Entry in the bundle - will have a resource

or information

fullUrl 01 uri The fullUrl element must be present when a resource is present and not present otherwise

Absolute URL for resource (server address or UUIDOID)

resource 01 Resource A resource in the bundle

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 12

424 OperationOutcome Resource

Based on httphl7orgfhiroperationoutcomehtml

Operation Outcomes are sets of error warning and information messages that provide detailed information about the outcome of some attempted system

operation They are provided as a direct system response or component of one where they provide information about the outcome of the operation

OperationOutcomes are used in the following circumstances

When an RESTful operation fails

As the response on a validation operation to provide information about the outcomes

As part of a message response usually when the message has not been processed correctly

This resource is not used for reporting clinical or workflow issues associated with a proposed or ongoing action The resource is not designed to be persisted or

referenced from other parts of the workflow

Name Card

Type ValueVocab Description Comments

issue 1 BackboneElement

A single issue associated with the action

severity 11 code ValueSethttphl7orgfhirvalueset-issue-severityhtml

fatal | error | warning | information

code 11 ValueSethttphl7orgfhirvalueset-issue-typehtml

Error or warning code

details 01 CodeableConcept

ValueSet httphl7orgfhirvalueset-operation-outcomehtml

Additional details about the error

diagnostics 01 string Additional diagnostic information about the issue

location 0 string XPath of element(s) related to issue

425 Using Operation Outcome Resources

On the RESTful interface operation outcome resources are only relevant when a level of computable detail is required that is more granular than that provided by

the HTTP response codes This granularity could include

more detail about the location of an issue

the ability to identify multiple distinct issues

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 13

provision of finer error codes that connect to known business failure states

426 Reporting Errors in the HTTP Headers

Server may also need to report errors in the HTTP headers - especially query parameters when processing searches Errors are reported using a case sensitive

location that has two parts a fixed http and the header or query parameter name separated by a Some examples

Location Description

httpnameexact A reference to the search parameter name with the modifier exact

httpAuthorization A reference to the Authorization header - perhaps to indicate that it is missing and some form of authentication is required

427 OperationOutcome Example - Search

resourceType OperationOutcome

id OperationOutcome1234

issue [

severity fatal

code code-invalid

details

text The name parameter has the modifier exact which is not supported by this server

location [

httpnameexact

]

]

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 14

FHIR Resources 43

DiagnosticReport

PractitionerOrdering Practitioner

Extension ResultCopiestoPractitioners

PatientDiagnosticReportSubject

Organization

PerformingLab

DiagnosticReport

OrganizationReportingLab

ObservationDiagnosticReportResult

SpecimenDiagnosticReportSpecimen

ProcedureRequestDiagnosticReportProcedureRequest

PractitionerAttendingAdmitting

OrganizationExtension

SpecimenCollectorCenter

OrganizationExtension

DestinationLabOrderPlacer

Encounter

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 15

431 Diagnostic Report Profile

ca-on-Diagnostic-DiagnosticReport based on Diagnostic Report profile httphl7orgfhirdiagnosticreporthtml

Name Card Type ValueVocab Description Comments identifier 11 Identifier Identifier assigned by the sending

organization - this is an identifier assigned outside FHIR

This field contains an identifier for the entire order The Placer Group Number is conceptually equivalent to a requisition number assigned to all test requests in an order by an organization (ORC4)

system 11 Uri

The source of the lab reports (ORC43)

value 11 string The unique identifier of the lab report record (ORC41)

status 11 code Value set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

code CodeableConcept

coding 11 coding Fixed code ldquo11502-2rdquo Code defined by a LOINC text 11 string Fixed value ldquoLaboratory Reportrdquo Plain text representation of the concept

Subject (patient)

11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

issued 01 instant dateTime when test request has been issued An instant in time - known at least to the second and always includes a time zone This field will be populated by system (OBR22)

performer 01 Reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

The individual responsible for reporting test result Can be reporting laboratory or reporting practitioner

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 16

Name Card Type ValueVocab Description Comments reference 11 string A reference to a location at which the

other resource is found

request 1 Reference Contained ca-on-Diagnostic-ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

specimen 01 Reference Contained ca-on-Diagnostic-Specimen (Specimen) resource

Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

Result 1 Reference Contained ca-on-Diagnostic-Observation (Observation) resource

List of all the observation associated with the test request (OBX)

reference 11 string A reference to a location at which the other resource is found

codedDiagnosi

s

01 CodeableCon

cept

Value Set ICD10 Diagnosis information

coding 11 coding A reference to a location at which the other resource is found

text 11 string A reference to a location at which the other resource is found

432 Procedure Request Profile

ca-on-Diagnostic-ProcedureRequest profile based on httphl7orgfhirprocedurerequesthtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier assigned by the ordering facility - this is an identifier assigned outside FHIR Must contain a value assigned by the order-placing organization that uniquely identifies this test request among all test requests in OLIS (OBR2)

system 11 Uri The source of test request on the lab report (OBR23)

value 11 string The unique identifier of the test request record (OBR21)

This represents the test request number from the LIS or HIS systems

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 17

Name Card Type ValueVocab Description Comments

status 11 code Value Set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

intent 11 code Value set httphl7orgfhirValueSetrequest-intent

proposal | plan | original-order | order| reflex-order (OBR11)

If OBR11 contains lsquoGrsquo populate lsquoreflex-testrsquo value otherwise fix the value to lsquoOrderrsquo

priority 11 code Value set httphl7orgfhirValueSetrequest-priority

routine | urgent | asap | stat

RequestPriority (Required) (OBR276)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Context (encounter)

11 Reference Contained ca-on-Diagnostic-Encounter (Encounter) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

occuranceDateTime

11 dateTime When testing should occur (OBR274) For routine orders populate this field with the current date

For timing-critical orders populate this field with the date and time that the specimen is to be obtained

For future-dated orders populate this field with the scheduled future date (and time if applicable) when the laboratory test is to occur

extension

01 DateTime of Transaction (ORC9) Populate this field with the

date and time of the event

that initiated the current

transaction

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 18

url 11 httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-dateTime-transaction

valueDateTime 11 dateTime

requester 11 BackboneElement

agent 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the personorganization making request to perform the test (ordering practitionerorganization OBR16)

IF Ordering Facility exists in the message (ORC21) Scenario 1 requester (OBR16) is organization populate ORC21 with the same organization information that in OBR16 field Scenario 2 requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

onBehalfOf 01 reference Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the organization agent is acting for ordering facility

Should be mapped to ordering facility (ORC21 and ORC22) where requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension CCrsquod list practitioner (OBR28) url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-cc-practitioner-list

valueReference (Practitioner)

110 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Practitioners named on an order (attending admitting ccrsquod)

reference 11 string A reference to a location at which the

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 19

other resource is found extension 01 Extension Test Request Placer ZBR2

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-test-request-placer

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Original Test Request Placer

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension Destination Laboratory ZBR8 url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-destination-laboratory

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Destination Laboratory

reference 11 string A reference to a location at which the other resource is found

note 05 Annotation comments authorString 11 string ZNT segment Indicate the organization

(or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

extension 11 Extension Source of Comment (NTE2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-source-comment

valueString

11 string

extension 11 Extension Set ID (NTE1)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 20

set-id

valueString

11 string

433 Observation Profile

ca-on-Diagnostic-Observation profile based on httphl7orgfhirobservationhtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Unique ID for the particular observation (OBR3)

system 11 uri The namespace for the identifier (OBR32) value 11 string The value that is unique (OBR31)

status 11 code Value set Observation result status (OBX11) code CodeableCo

ncept Value set LOINCSNOMED CT

Test result code (OBX3)

coding 11 coding Code defined by a terminology system (OBX31)

text 11 string Plain text representation of the concept (OBX32)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

effective 01 Clinically relevant time for observation

effectiveDateTime

01 dateTime DateTime of observation OBX141 Use this field for ancillary order only

This field must be empty when a laboratory reports a test result

issued 11 instant Indicate the date and time that the Test Result was released by the Reporting Laboratory (ZBX1)

performer (organization)

11 Reference Contained ca-on-Deagnostic-Organization (Organization) Resource or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

The individual responsible for performing the test Can be laboratory or practitioner

reference 11 string A reference to a location at which the other resource is found

value 11 Actual result

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 21

Name Card Type ValueVocab Description Comments

valueQuantity 11 Quantity (OBX2)-Only numeric test value value 11 decimal Numeric value of the test result (OBX5) unit 01 string When observation Value is a scalar value this

field describes the units of measure (OBX61)

interpretation 01 CodebaleConcept

Observation Interpretation Codes(OBX8)

coding 01 Coding Value set method 01 CodebaleCo

ncept How the observation has been done (OBX17)

text 11 string Plain text (OBX172) specimen 01 Reference Contained ca-on-Diagnostic-

Specimen (Specimen) resource Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

referenceRange 01 BackboneElement

Normal range of value associated with observation result (OBX7)

text 11 string Text based reference range in an observation

extension 01 Extension Nature of Abnormal Test (OBX10)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-nature-abnormal-test

valuecoding

11 coding Value set

extension 01 Extension Observation sub-id (OBX4)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation sort key (ZBX2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation comment (NTE-ZNT)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 22

url 11 uri httpehealthontariocaAPIfhir

StructureDefinitiondiagnosticReport-ext-observation-comment

valueAnnotation

11 annotation

authorString

11 string ZNT segment Indicate the organization (or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

434 Specimen Profile

ca-on-Diagnostic-Specimen profile based on httphl7orgfhirspecimenhtml

Name Card Type ValueVocab Description Comments

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

receivedTime 11 dateTime The time when specimen was received for processing

OBR14

request 1 Reference Contained ca-on-Diagnostic- ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

extension 11 Extension Organization that collected the specimen

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-specimen-collector-center

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Specimen Collector Center (ZBR3)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 23

Name Card Type ValueVocab Description Comments

Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

reference 11 string A reference to a location at which the other resource is found

reference 11 string A reference to a location at which the other resource is found

collected 01 Specimen collection time CollectedPeriod 11 Period

start 01 dateTime Starting specimen time OBR7 end 01 dateTime End specimen time OBR8

type 01 CodeableConcept

Kind of material that forms the specimen (Specimen Type)

OBR15

coding 01 coding Value Set from OLIS Code define by the terminology system

OBR1511

text 01 string Plain text representation of the concept

OBR1512

bodySite 01 CodeableConcept

Value Set Anatomical collection site OBR155

container 01 BackboneElement

Direct container of specimen

identifier 02 identifier Id for container OBR18 andor OBR20 Referring Lab User Specimen Identifier and Performing Lab User Specimen Identifier on Refereed ndashout orders

specimenQuantity

01 SimpleQuantity

Quantity of specimen within container

OBR37

note 01 Annotation Collectors comments text 11 string Collectors comments OBR39

extension 01 Extension Collection volume (OBR9)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-collection-volume

valueQuantity

11 Quantity

value 11 decimal Numeric value of the collection OBR91

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 24

volume unit 01 string Units of measure OBR921

435 Patient Profile

ca-on-Diagnostic-Patient profile based on httphl7orgfhirpatienthtml

Name

Card Type ValueVocab Description Comment

identifier

1 Identifier An identifier for this patient

system 11 uri [id-system-global-base]ca-on-patient-hcn

Patient Identifier Assigning Authority Namespace in which set of possible id values is unique (PID391 PID392 PID393)

Value 11 string Patient Identifier Number The portion of the identifier typically displayed to the user and which is unique within the context of the system (PID31)

extension 01 Health Card Version code (PID311) this is an extension patient identifier

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionext-identifier-hcn-version-code

valueString 11 string name

01 HumanName

use 11 code Value set httphl7orgfhirValueSetname-use

Purpose of this name Name type code PID57

Fix to the official for all cases except for anonymous For anonymous code should be lsquoanonymousrsquo

family 11 string Patient Last Name (PID51) given 02 string Patient First Name(PID52) extension 01 patient middle name (PID53)

this is an extension of given name

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode 11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name (PID55)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 25

Name

Card Type ValueVocab Description Comment

suffix 02 String Parts that come after the name (PID54)

extension 01 Patient degree designation This is an extension of suffix

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoACrdquo Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

telecom 03 Demographics Patient table Telephone Number system 01 code httphl7orgfhir

ValueSetcontact-point-system

Telecommunications form for contact point (Phone fax email pager url sms other) PID133 or PID143

Value 11 string The actual contact point details PID134-PID138 Or PID144-PID148

use 01 code httphl7orgfhirValueSetcontact-point-use

Use of contact point (Home work temp old mobile) PID132 or PID142

gender 11 code ldquomalerdquo ldquofemalerdquo ldquootherrdquo ldquounknownrdquo (httphl7orgfhirValueSetadministrative-gender)

The gender of a person used for administrative purposes (PID8)

birthDate 11 date The date of birth for the individual (PID7) Deceased[x]

01 boolean|dateTime

Indicates if the individual is deceased or not The value must be one of the choices specified below but not both System creating instance of this resource must decide which type to use at run time (PID30)

deceasedBoolean

boolean true|false

deceasedDateTime

dateTime Deceased datetime if known (PID29)

address 12 Address Demographics Patient table Address for the individual (PID11)

use 11 code ValueSet httphl7orgfhir

Address Type The use of an address

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 26

Name

Card Type ValueVocab Description Comment

ValueSetaddress-use

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

line 11 string Street lines (PID111) city 11 string Name of city town etc (PID113) state 01 string Province or territory (PID114) postalCode 01 string Postal code for area (PID115) country 11 string Country (can be ISO 3166 3 letter code) (PID116)

436 Practitioner Profile (Ordering Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent Ordering Practitioner information

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR1622

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR161

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR162 given 12 string Practitioner First Name OBR163

extension

01 Practitioner middle name this is an extension of given name

OBR164

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 13: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 10

4 FHIR Resources Definitions

General Overview 41

411 Supported Attributes

Only attributes described in the subsections below will be supported

412 Format

OLIS will support JSON and XML formats JSON is the preferred format

Infrastructure Resources 42

421 Resource - Base Resource Definitions

httpwwwhl7orgFHIRresourcehtml Name Card Type ValueVocab Description Comments id 01 id Unique ID set by FHIR server Logical id of this artifact meta 01 Meta Only ldquolastUpdatedrdquo element to be populated

by FHIR server Metadata about the resource

lastUpdated 01 instant This value changes each time the content of the resource changes

language 01 code Used only for Bundle and fixed to ldquoenrdquo in the current release

Language of the resource content

422 DomainResource Resource

httpwwwhl7orgFHIRdomainresourcehtml

A resource with narrative extensions and contained resources

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 11

If a resource is contained in another resource it SHALL NOT have a metaversionId or a metalastUpdated

If the resource is contained in another resource it SHALL be referred to from elsewhere in the resource

If the resource is contained in another resource it SHALL NOT contain nested Resources

If the resource is contained in another resource it SHALL NOT contain any narrative

Most resources are derived from Domain Resources - so they also can contain text contained resources extensions and data elements specific to the particular

domain of the resource

Name Card Type ValueVocab Description Comments text 01 Narrative Text summary of the resource for human

interpretation Not used in the current release

contained 0 Resource Contained inline Resources extension 0 Extension Additional Content defined by

implementations

modifierExtension

0 Extension Extensions that cannot be ignored

423 Bundle Resource

Based on httpwwwhl7orgFHIRbundlehtml

A special type of resource for collections of resources

A set of search results (type = searchset) consists of a series of zero or more entries Each entry element will contain a resource

Bundletotal may be used to return the total number of resources that match the search and that may be returned by following the next link

Name Card Type ValueVocab Description Comments type 11 code Fixed to ldquosearchsetrdquo Type of bundle total 01 unsignedI

nt The total number of matches

link 0 BackboneElement

Links related to this Bundle Optional element might be returned by a server

relation 11 string ldquoselfrdquo for the link to the this Bundle ldquonextrdquo for the link to the next page

ValueSet httpwwwianaorgassignmentslink-relationslink-relationsxhtml

url 11 uri Reference details for the link entry 0 Backbone

Element Entry in the bundle - will have a resource

or information

fullUrl 01 uri The fullUrl element must be present when a resource is present and not present otherwise

Absolute URL for resource (server address or UUIDOID)

resource 01 Resource A resource in the bundle

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 12

424 OperationOutcome Resource

Based on httphl7orgfhiroperationoutcomehtml

Operation Outcomes are sets of error warning and information messages that provide detailed information about the outcome of some attempted system

operation They are provided as a direct system response or component of one where they provide information about the outcome of the operation

OperationOutcomes are used in the following circumstances

When an RESTful operation fails

As the response on a validation operation to provide information about the outcomes

As part of a message response usually when the message has not been processed correctly

This resource is not used for reporting clinical or workflow issues associated with a proposed or ongoing action The resource is not designed to be persisted or

referenced from other parts of the workflow

Name Card

Type ValueVocab Description Comments

issue 1 BackboneElement

A single issue associated with the action

severity 11 code ValueSethttphl7orgfhirvalueset-issue-severityhtml

fatal | error | warning | information

code 11 ValueSethttphl7orgfhirvalueset-issue-typehtml

Error or warning code

details 01 CodeableConcept

ValueSet httphl7orgfhirvalueset-operation-outcomehtml

Additional details about the error

diagnostics 01 string Additional diagnostic information about the issue

location 0 string XPath of element(s) related to issue

425 Using Operation Outcome Resources

On the RESTful interface operation outcome resources are only relevant when a level of computable detail is required that is more granular than that provided by

the HTTP response codes This granularity could include

more detail about the location of an issue

the ability to identify multiple distinct issues

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 13

provision of finer error codes that connect to known business failure states

426 Reporting Errors in the HTTP Headers

Server may also need to report errors in the HTTP headers - especially query parameters when processing searches Errors are reported using a case sensitive

location that has two parts a fixed http and the header or query parameter name separated by a Some examples

Location Description

httpnameexact A reference to the search parameter name with the modifier exact

httpAuthorization A reference to the Authorization header - perhaps to indicate that it is missing and some form of authentication is required

427 OperationOutcome Example - Search

resourceType OperationOutcome

id OperationOutcome1234

issue [

severity fatal

code code-invalid

details

text The name parameter has the modifier exact which is not supported by this server

location [

httpnameexact

]

]

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 14

FHIR Resources 43

DiagnosticReport

PractitionerOrdering Practitioner

Extension ResultCopiestoPractitioners

PatientDiagnosticReportSubject

Organization

PerformingLab

DiagnosticReport

OrganizationReportingLab

ObservationDiagnosticReportResult

SpecimenDiagnosticReportSpecimen

ProcedureRequestDiagnosticReportProcedureRequest

PractitionerAttendingAdmitting

OrganizationExtension

SpecimenCollectorCenter

OrganizationExtension

DestinationLabOrderPlacer

Encounter

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 15

431 Diagnostic Report Profile

ca-on-Diagnostic-DiagnosticReport based on Diagnostic Report profile httphl7orgfhirdiagnosticreporthtml

Name Card Type ValueVocab Description Comments identifier 11 Identifier Identifier assigned by the sending

organization - this is an identifier assigned outside FHIR

This field contains an identifier for the entire order The Placer Group Number is conceptually equivalent to a requisition number assigned to all test requests in an order by an organization (ORC4)

system 11 Uri

The source of the lab reports (ORC43)

value 11 string The unique identifier of the lab report record (ORC41)

status 11 code Value set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

code CodeableConcept

coding 11 coding Fixed code ldquo11502-2rdquo Code defined by a LOINC text 11 string Fixed value ldquoLaboratory Reportrdquo Plain text representation of the concept

Subject (patient)

11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

issued 01 instant dateTime when test request has been issued An instant in time - known at least to the second and always includes a time zone This field will be populated by system (OBR22)

performer 01 Reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

The individual responsible for reporting test result Can be reporting laboratory or reporting practitioner

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 16

Name Card Type ValueVocab Description Comments reference 11 string A reference to a location at which the

other resource is found

request 1 Reference Contained ca-on-Diagnostic-ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

specimen 01 Reference Contained ca-on-Diagnostic-Specimen (Specimen) resource

Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

Result 1 Reference Contained ca-on-Diagnostic-Observation (Observation) resource

List of all the observation associated with the test request (OBX)

reference 11 string A reference to a location at which the other resource is found

codedDiagnosi

s

01 CodeableCon

cept

Value Set ICD10 Diagnosis information

coding 11 coding A reference to a location at which the other resource is found

text 11 string A reference to a location at which the other resource is found

432 Procedure Request Profile

ca-on-Diagnostic-ProcedureRequest profile based on httphl7orgfhirprocedurerequesthtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier assigned by the ordering facility - this is an identifier assigned outside FHIR Must contain a value assigned by the order-placing organization that uniquely identifies this test request among all test requests in OLIS (OBR2)

system 11 Uri The source of test request on the lab report (OBR23)

value 11 string The unique identifier of the test request record (OBR21)

This represents the test request number from the LIS or HIS systems

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 17

Name Card Type ValueVocab Description Comments

status 11 code Value Set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

intent 11 code Value set httphl7orgfhirValueSetrequest-intent

proposal | plan | original-order | order| reflex-order (OBR11)

If OBR11 contains lsquoGrsquo populate lsquoreflex-testrsquo value otherwise fix the value to lsquoOrderrsquo

priority 11 code Value set httphl7orgfhirValueSetrequest-priority

routine | urgent | asap | stat

RequestPriority (Required) (OBR276)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Context (encounter)

11 Reference Contained ca-on-Diagnostic-Encounter (Encounter) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

occuranceDateTime

11 dateTime When testing should occur (OBR274) For routine orders populate this field with the current date

For timing-critical orders populate this field with the date and time that the specimen is to be obtained

For future-dated orders populate this field with the scheduled future date (and time if applicable) when the laboratory test is to occur

extension

01 DateTime of Transaction (ORC9) Populate this field with the

date and time of the event

that initiated the current

transaction

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 18

url 11 httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-dateTime-transaction

valueDateTime 11 dateTime

requester 11 BackboneElement

agent 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the personorganization making request to perform the test (ordering practitionerorganization OBR16)

IF Ordering Facility exists in the message (ORC21) Scenario 1 requester (OBR16) is organization populate ORC21 with the same organization information that in OBR16 field Scenario 2 requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

onBehalfOf 01 reference Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the organization agent is acting for ordering facility

Should be mapped to ordering facility (ORC21 and ORC22) where requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension CCrsquod list practitioner (OBR28) url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-cc-practitioner-list

valueReference (Practitioner)

110 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Practitioners named on an order (attending admitting ccrsquod)

reference 11 string A reference to a location at which the

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 19

other resource is found extension 01 Extension Test Request Placer ZBR2

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-test-request-placer

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Original Test Request Placer

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension Destination Laboratory ZBR8 url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-destination-laboratory

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Destination Laboratory

reference 11 string A reference to a location at which the other resource is found

note 05 Annotation comments authorString 11 string ZNT segment Indicate the organization

(or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

extension 11 Extension Source of Comment (NTE2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-source-comment

valueString

11 string

extension 11 Extension Set ID (NTE1)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 20

set-id

valueString

11 string

433 Observation Profile

ca-on-Diagnostic-Observation profile based on httphl7orgfhirobservationhtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Unique ID for the particular observation (OBR3)

system 11 uri The namespace for the identifier (OBR32) value 11 string The value that is unique (OBR31)

status 11 code Value set Observation result status (OBX11) code CodeableCo

ncept Value set LOINCSNOMED CT

Test result code (OBX3)

coding 11 coding Code defined by a terminology system (OBX31)

text 11 string Plain text representation of the concept (OBX32)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

effective 01 Clinically relevant time for observation

effectiveDateTime

01 dateTime DateTime of observation OBX141 Use this field for ancillary order only

This field must be empty when a laboratory reports a test result

issued 11 instant Indicate the date and time that the Test Result was released by the Reporting Laboratory (ZBX1)

performer (organization)

11 Reference Contained ca-on-Deagnostic-Organization (Organization) Resource or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

The individual responsible for performing the test Can be laboratory or practitioner

reference 11 string A reference to a location at which the other resource is found

value 11 Actual result

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 21

Name Card Type ValueVocab Description Comments

valueQuantity 11 Quantity (OBX2)-Only numeric test value value 11 decimal Numeric value of the test result (OBX5) unit 01 string When observation Value is a scalar value this

field describes the units of measure (OBX61)

interpretation 01 CodebaleConcept

Observation Interpretation Codes(OBX8)

coding 01 Coding Value set method 01 CodebaleCo

ncept How the observation has been done (OBX17)

text 11 string Plain text (OBX172) specimen 01 Reference Contained ca-on-Diagnostic-

Specimen (Specimen) resource Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

referenceRange 01 BackboneElement

Normal range of value associated with observation result (OBX7)

text 11 string Text based reference range in an observation

extension 01 Extension Nature of Abnormal Test (OBX10)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-nature-abnormal-test

valuecoding

11 coding Value set

extension 01 Extension Observation sub-id (OBX4)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation sort key (ZBX2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation comment (NTE-ZNT)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 22

url 11 uri httpehealthontariocaAPIfhir

StructureDefinitiondiagnosticReport-ext-observation-comment

valueAnnotation

11 annotation

authorString

11 string ZNT segment Indicate the organization (or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

434 Specimen Profile

ca-on-Diagnostic-Specimen profile based on httphl7orgfhirspecimenhtml

Name Card Type ValueVocab Description Comments

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

receivedTime 11 dateTime The time when specimen was received for processing

OBR14

request 1 Reference Contained ca-on-Diagnostic- ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

extension 11 Extension Organization that collected the specimen

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-specimen-collector-center

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Specimen Collector Center (ZBR3)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 23

Name Card Type ValueVocab Description Comments

Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

reference 11 string A reference to a location at which the other resource is found

reference 11 string A reference to a location at which the other resource is found

collected 01 Specimen collection time CollectedPeriod 11 Period

start 01 dateTime Starting specimen time OBR7 end 01 dateTime End specimen time OBR8

type 01 CodeableConcept

Kind of material that forms the specimen (Specimen Type)

OBR15

coding 01 coding Value Set from OLIS Code define by the terminology system

OBR1511

text 01 string Plain text representation of the concept

OBR1512

bodySite 01 CodeableConcept

Value Set Anatomical collection site OBR155

container 01 BackboneElement

Direct container of specimen

identifier 02 identifier Id for container OBR18 andor OBR20 Referring Lab User Specimen Identifier and Performing Lab User Specimen Identifier on Refereed ndashout orders

specimenQuantity

01 SimpleQuantity

Quantity of specimen within container

OBR37

note 01 Annotation Collectors comments text 11 string Collectors comments OBR39

extension 01 Extension Collection volume (OBR9)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-collection-volume

valueQuantity

11 Quantity

value 11 decimal Numeric value of the collection OBR91

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 24

volume unit 01 string Units of measure OBR921

435 Patient Profile

ca-on-Diagnostic-Patient profile based on httphl7orgfhirpatienthtml

Name

Card Type ValueVocab Description Comment

identifier

1 Identifier An identifier for this patient

system 11 uri [id-system-global-base]ca-on-patient-hcn

Patient Identifier Assigning Authority Namespace in which set of possible id values is unique (PID391 PID392 PID393)

Value 11 string Patient Identifier Number The portion of the identifier typically displayed to the user and which is unique within the context of the system (PID31)

extension 01 Health Card Version code (PID311) this is an extension patient identifier

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionext-identifier-hcn-version-code

valueString 11 string name

01 HumanName

use 11 code Value set httphl7orgfhirValueSetname-use

Purpose of this name Name type code PID57

Fix to the official for all cases except for anonymous For anonymous code should be lsquoanonymousrsquo

family 11 string Patient Last Name (PID51) given 02 string Patient First Name(PID52) extension 01 patient middle name (PID53)

this is an extension of given name

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode 11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name (PID55)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 25

Name

Card Type ValueVocab Description Comment

suffix 02 String Parts that come after the name (PID54)

extension 01 Patient degree designation This is an extension of suffix

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoACrdquo Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

telecom 03 Demographics Patient table Telephone Number system 01 code httphl7orgfhir

ValueSetcontact-point-system

Telecommunications form for contact point (Phone fax email pager url sms other) PID133 or PID143

Value 11 string The actual contact point details PID134-PID138 Or PID144-PID148

use 01 code httphl7orgfhirValueSetcontact-point-use

Use of contact point (Home work temp old mobile) PID132 or PID142

gender 11 code ldquomalerdquo ldquofemalerdquo ldquootherrdquo ldquounknownrdquo (httphl7orgfhirValueSetadministrative-gender)

The gender of a person used for administrative purposes (PID8)

birthDate 11 date The date of birth for the individual (PID7) Deceased[x]

01 boolean|dateTime

Indicates if the individual is deceased or not The value must be one of the choices specified below but not both System creating instance of this resource must decide which type to use at run time (PID30)

deceasedBoolean

boolean true|false

deceasedDateTime

dateTime Deceased datetime if known (PID29)

address 12 Address Demographics Patient table Address for the individual (PID11)

use 11 code ValueSet httphl7orgfhir

Address Type The use of an address

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 26

Name

Card Type ValueVocab Description Comment

ValueSetaddress-use

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

line 11 string Street lines (PID111) city 11 string Name of city town etc (PID113) state 01 string Province or territory (PID114) postalCode 01 string Postal code for area (PID115) country 11 string Country (can be ISO 3166 3 letter code) (PID116)

436 Practitioner Profile (Ordering Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent Ordering Practitioner information

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR1622

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR161

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR162 given 12 string Practitioner First Name OBR163

extension

01 Practitioner middle name this is an extension of given name

OBR164

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 14: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 11

If a resource is contained in another resource it SHALL NOT have a metaversionId or a metalastUpdated

If the resource is contained in another resource it SHALL be referred to from elsewhere in the resource

If the resource is contained in another resource it SHALL NOT contain nested Resources

If the resource is contained in another resource it SHALL NOT contain any narrative

Most resources are derived from Domain Resources - so they also can contain text contained resources extensions and data elements specific to the particular

domain of the resource

Name Card Type ValueVocab Description Comments text 01 Narrative Text summary of the resource for human

interpretation Not used in the current release

contained 0 Resource Contained inline Resources extension 0 Extension Additional Content defined by

implementations

modifierExtension

0 Extension Extensions that cannot be ignored

423 Bundle Resource

Based on httpwwwhl7orgFHIRbundlehtml

A special type of resource for collections of resources

A set of search results (type = searchset) consists of a series of zero or more entries Each entry element will contain a resource

Bundletotal may be used to return the total number of resources that match the search and that may be returned by following the next link

Name Card Type ValueVocab Description Comments type 11 code Fixed to ldquosearchsetrdquo Type of bundle total 01 unsignedI

nt The total number of matches

link 0 BackboneElement

Links related to this Bundle Optional element might be returned by a server

relation 11 string ldquoselfrdquo for the link to the this Bundle ldquonextrdquo for the link to the next page

ValueSet httpwwwianaorgassignmentslink-relationslink-relationsxhtml

url 11 uri Reference details for the link entry 0 Backbone

Element Entry in the bundle - will have a resource

or information

fullUrl 01 uri The fullUrl element must be present when a resource is present and not present otherwise

Absolute URL for resource (server address or UUIDOID)

resource 01 Resource A resource in the bundle

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 12

424 OperationOutcome Resource

Based on httphl7orgfhiroperationoutcomehtml

Operation Outcomes are sets of error warning and information messages that provide detailed information about the outcome of some attempted system

operation They are provided as a direct system response or component of one where they provide information about the outcome of the operation

OperationOutcomes are used in the following circumstances

When an RESTful operation fails

As the response on a validation operation to provide information about the outcomes

As part of a message response usually when the message has not been processed correctly

This resource is not used for reporting clinical or workflow issues associated with a proposed or ongoing action The resource is not designed to be persisted or

referenced from other parts of the workflow

Name Card

Type ValueVocab Description Comments

issue 1 BackboneElement

A single issue associated with the action

severity 11 code ValueSethttphl7orgfhirvalueset-issue-severityhtml

fatal | error | warning | information

code 11 ValueSethttphl7orgfhirvalueset-issue-typehtml

Error or warning code

details 01 CodeableConcept

ValueSet httphl7orgfhirvalueset-operation-outcomehtml

Additional details about the error

diagnostics 01 string Additional diagnostic information about the issue

location 0 string XPath of element(s) related to issue

425 Using Operation Outcome Resources

On the RESTful interface operation outcome resources are only relevant when a level of computable detail is required that is more granular than that provided by

the HTTP response codes This granularity could include

more detail about the location of an issue

the ability to identify multiple distinct issues

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 13

provision of finer error codes that connect to known business failure states

426 Reporting Errors in the HTTP Headers

Server may also need to report errors in the HTTP headers - especially query parameters when processing searches Errors are reported using a case sensitive

location that has two parts a fixed http and the header or query parameter name separated by a Some examples

Location Description

httpnameexact A reference to the search parameter name with the modifier exact

httpAuthorization A reference to the Authorization header - perhaps to indicate that it is missing and some form of authentication is required

427 OperationOutcome Example - Search

resourceType OperationOutcome

id OperationOutcome1234

issue [

severity fatal

code code-invalid

details

text The name parameter has the modifier exact which is not supported by this server

location [

httpnameexact

]

]

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 14

FHIR Resources 43

DiagnosticReport

PractitionerOrdering Practitioner

Extension ResultCopiestoPractitioners

PatientDiagnosticReportSubject

Organization

PerformingLab

DiagnosticReport

OrganizationReportingLab

ObservationDiagnosticReportResult

SpecimenDiagnosticReportSpecimen

ProcedureRequestDiagnosticReportProcedureRequest

PractitionerAttendingAdmitting

OrganizationExtension

SpecimenCollectorCenter

OrganizationExtension

DestinationLabOrderPlacer

Encounter

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 15

431 Diagnostic Report Profile

ca-on-Diagnostic-DiagnosticReport based on Diagnostic Report profile httphl7orgfhirdiagnosticreporthtml

Name Card Type ValueVocab Description Comments identifier 11 Identifier Identifier assigned by the sending

organization - this is an identifier assigned outside FHIR

This field contains an identifier for the entire order The Placer Group Number is conceptually equivalent to a requisition number assigned to all test requests in an order by an organization (ORC4)

system 11 Uri

The source of the lab reports (ORC43)

value 11 string The unique identifier of the lab report record (ORC41)

status 11 code Value set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

code CodeableConcept

coding 11 coding Fixed code ldquo11502-2rdquo Code defined by a LOINC text 11 string Fixed value ldquoLaboratory Reportrdquo Plain text representation of the concept

Subject (patient)

11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

issued 01 instant dateTime when test request has been issued An instant in time - known at least to the second and always includes a time zone This field will be populated by system (OBR22)

performer 01 Reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

The individual responsible for reporting test result Can be reporting laboratory or reporting practitioner

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 16

Name Card Type ValueVocab Description Comments reference 11 string A reference to a location at which the

other resource is found

request 1 Reference Contained ca-on-Diagnostic-ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

specimen 01 Reference Contained ca-on-Diagnostic-Specimen (Specimen) resource

Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

Result 1 Reference Contained ca-on-Diagnostic-Observation (Observation) resource

List of all the observation associated with the test request (OBX)

reference 11 string A reference to a location at which the other resource is found

codedDiagnosi

s

01 CodeableCon

cept

Value Set ICD10 Diagnosis information

coding 11 coding A reference to a location at which the other resource is found

text 11 string A reference to a location at which the other resource is found

432 Procedure Request Profile

ca-on-Diagnostic-ProcedureRequest profile based on httphl7orgfhirprocedurerequesthtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier assigned by the ordering facility - this is an identifier assigned outside FHIR Must contain a value assigned by the order-placing organization that uniquely identifies this test request among all test requests in OLIS (OBR2)

system 11 Uri The source of test request on the lab report (OBR23)

value 11 string The unique identifier of the test request record (OBR21)

This represents the test request number from the LIS or HIS systems

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 17

Name Card Type ValueVocab Description Comments

status 11 code Value Set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

intent 11 code Value set httphl7orgfhirValueSetrequest-intent

proposal | plan | original-order | order| reflex-order (OBR11)

If OBR11 contains lsquoGrsquo populate lsquoreflex-testrsquo value otherwise fix the value to lsquoOrderrsquo

priority 11 code Value set httphl7orgfhirValueSetrequest-priority

routine | urgent | asap | stat

RequestPriority (Required) (OBR276)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Context (encounter)

11 Reference Contained ca-on-Diagnostic-Encounter (Encounter) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

occuranceDateTime

11 dateTime When testing should occur (OBR274) For routine orders populate this field with the current date

For timing-critical orders populate this field with the date and time that the specimen is to be obtained

For future-dated orders populate this field with the scheduled future date (and time if applicable) when the laboratory test is to occur

extension

01 DateTime of Transaction (ORC9) Populate this field with the

date and time of the event

that initiated the current

transaction

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 18

url 11 httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-dateTime-transaction

valueDateTime 11 dateTime

requester 11 BackboneElement

agent 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the personorganization making request to perform the test (ordering practitionerorganization OBR16)

IF Ordering Facility exists in the message (ORC21) Scenario 1 requester (OBR16) is organization populate ORC21 with the same organization information that in OBR16 field Scenario 2 requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

onBehalfOf 01 reference Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the organization agent is acting for ordering facility

Should be mapped to ordering facility (ORC21 and ORC22) where requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension CCrsquod list practitioner (OBR28) url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-cc-practitioner-list

valueReference (Practitioner)

110 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Practitioners named on an order (attending admitting ccrsquod)

reference 11 string A reference to a location at which the

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 19

other resource is found extension 01 Extension Test Request Placer ZBR2

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-test-request-placer

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Original Test Request Placer

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension Destination Laboratory ZBR8 url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-destination-laboratory

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Destination Laboratory

reference 11 string A reference to a location at which the other resource is found

note 05 Annotation comments authorString 11 string ZNT segment Indicate the organization

(or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

extension 11 Extension Source of Comment (NTE2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-source-comment

valueString

11 string

extension 11 Extension Set ID (NTE1)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 20

set-id

valueString

11 string

433 Observation Profile

ca-on-Diagnostic-Observation profile based on httphl7orgfhirobservationhtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Unique ID for the particular observation (OBR3)

system 11 uri The namespace for the identifier (OBR32) value 11 string The value that is unique (OBR31)

status 11 code Value set Observation result status (OBX11) code CodeableCo

ncept Value set LOINCSNOMED CT

Test result code (OBX3)

coding 11 coding Code defined by a terminology system (OBX31)

text 11 string Plain text representation of the concept (OBX32)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

effective 01 Clinically relevant time for observation

effectiveDateTime

01 dateTime DateTime of observation OBX141 Use this field for ancillary order only

This field must be empty when a laboratory reports a test result

issued 11 instant Indicate the date and time that the Test Result was released by the Reporting Laboratory (ZBX1)

performer (organization)

11 Reference Contained ca-on-Deagnostic-Organization (Organization) Resource or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

The individual responsible for performing the test Can be laboratory or practitioner

reference 11 string A reference to a location at which the other resource is found

value 11 Actual result

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 21

Name Card Type ValueVocab Description Comments

valueQuantity 11 Quantity (OBX2)-Only numeric test value value 11 decimal Numeric value of the test result (OBX5) unit 01 string When observation Value is a scalar value this

field describes the units of measure (OBX61)

interpretation 01 CodebaleConcept

Observation Interpretation Codes(OBX8)

coding 01 Coding Value set method 01 CodebaleCo

ncept How the observation has been done (OBX17)

text 11 string Plain text (OBX172) specimen 01 Reference Contained ca-on-Diagnostic-

Specimen (Specimen) resource Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

referenceRange 01 BackboneElement

Normal range of value associated with observation result (OBX7)

text 11 string Text based reference range in an observation

extension 01 Extension Nature of Abnormal Test (OBX10)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-nature-abnormal-test

valuecoding

11 coding Value set

extension 01 Extension Observation sub-id (OBX4)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation sort key (ZBX2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation comment (NTE-ZNT)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 22

url 11 uri httpehealthontariocaAPIfhir

StructureDefinitiondiagnosticReport-ext-observation-comment

valueAnnotation

11 annotation

authorString

11 string ZNT segment Indicate the organization (or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

434 Specimen Profile

ca-on-Diagnostic-Specimen profile based on httphl7orgfhirspecimenhtml

Name Card Type ValueVocab Description Comments

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

receivedTime 11 dateTime The time when specimen was received for processing

OBR14

request 1 Reference Contained ca-on-Diagnostic- ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

extension 11 Extension Organization that collected the specimen

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-specimen-collector-center

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Specimen Collector Center (ZBR3)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 23

Name Card Type ValueVocab Description Comments

Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

reference 11 string A reference to a location at which the other resource is found

reference 11 string A reference to a location at which the other resource is found

collected 01 Specimen collection time CollectedPeriod 11 Period

start 01 dateTime Starting specimen time OBR7 end 01 dateTime End specimen time OBR8

type 01 CodeableConcept

Kind of material that forms the specimen (Specimen Type)

OBR15

coding 01 coding Value Set from OLIS Code define by the terminology system

OBR1511

text 01 string Plain text representation of the concept

OBR1512

bodySite 01 CodeableConcept

Value Set Anatomical collection site OBR155

container 01 BackboneElement

Direct container of specimen

identifier 02 identifier Id for container OBR18 andor OBR20 Referring Lab User Specimen Identifier and Performing Lab User Specimen Identifier on Refereed ndashout orders

specimenQuantity

01 SimpleQuantity

Quantity of specimen within container

OBR37

note 01 Annotation Collectors comments text 11 string Collectors comments OBR39

extension 01 Extension Collection volume (OBR9)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-collection-volume

valueQuantity

11 Quantity

value 11 decimal Numeric value of the collection OBR91

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 24

volume unit 01 string Units of measure OBR921

435 Patient Profile

ca-on-Diagnostic-Patient profile based on httphl7orgfhirpatienthtml

Name

Card Type ValueVocab Description Comment

identifier

1 Identifier An identifier for this patient

system 11 uri [id-system-global-base]ca-on-patient-hcn

Patient Identifier Assigning Authority Namespace in which set of possible id values is unique (PID391 PID392 PID393)

Value 11 string Patient Identifier Number The portion of the identifier typically displayed to the user and which is unique within the context of the system (PID31)

extension 01 Health Card Version code (PID311) this is an extension patient identifier

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionext-identifier-hcn-version-code

valueString 11 string name

01 HumanName

use 11 code Value set httphl7orgfhirValueSetname-use

Purpose of this name Name type code PID57

Fix to the official for all cases except for anonymous For anonymous code should be lsquoanonymousrsquo

family 11 string Patient Last Name (PID51) given 02 string Patient First Name(PID52) extension 01 patient middle name (PID53)

this is an extension of given name

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode 11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name (PID55)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 25

Name

Card Type ValueVocab Description Comment

suffix 02 String Parts that come after the name (PID54)

extension 01 Patient degree designation This is an extension of suffix

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoACrdquo Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

telecom 03 Demographics Patient table Telephone Number system 01 code httphl7orgfhir

ValueSetcontact-point-system

Telecommunications form for contact point (Phone fax email pager url sms other) PID133 or PID143

Value 11 string The actual contact point details PID134-PID138 Or PID144-PID148

use 01 code httphl7orgfhirValueSetcontact-point-use

Use of contact point (Home work temp old mobile) PID132 or PID142

gender 11 code ldquomalerdquo ldquofemalerdquo ldquootherrdquo ldquounknownrdquo (httphl7orgfhirValueSetadministrative-gender)

The gender of a person used for administrative purposes (PID8)

birthDate 11 date The date of birth for the individual (PID7) Deceased[x]

01 boolean|dateTime

Indicates if the individual is deceased or not The value must be one of the choices specified below but not both System creating instance of this resource must decide which type to use at run time (PID30)

deceasedBoolean

boolean true|false

deceasedDateTime

dateTime Deceased datetime if known (PID29)

address 12 Address Demographics Patient table Address for the individual (PID11)

use 11 code ValueSet httphl7orgfhir

Address Type The use of an address

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 26

Name

Card Type ValueVocab Description Comment

ValueSetaddress-use

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

line 11 string Street lines (PID111) city 11 string Name of city town etc (PID113) state 01 string Province or territory (PID114) postalCode 01 string Postal code for area (PID115) country 11 string Country (can be ISO 3166 3 letter code) (PID116)

436 Practitioner Profile (Ordering Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent Ordering Practitioner information

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR1622

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR161

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR162 given 12 string Practitioner First Name OBR163

extension

01 Practitioner middle name this is an extension of given name

OBR164

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 15: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 12

424 OperationOutcome Resource

Based on httphl7orgfhiroperationoutcomehtml

Operation Outcomes are sets of error warning and information messages that provide detailed information about the outcome of some attempted system

operation They are provided as a direct system response or component of one where they provide information about the outcome of the operation

OperationOutcomes are used in the following circumstances

When an RESTful operation fails

As the response on a validation operation to provide information about the outcomes

As part of a message response usually when the message has not been processed correctly

This resource is not used for reporting clinical or workflow issues associated with a proposed or ongoing action The resource is not designed to be persisted or

referenced from other parts of the workflow

Name Card

Type ValueVocab Description Comments

issue 1 BackboneElement

A single issue associated with the action

severity 11 code ValueSethttphl7orgfhirvalueset-issue-severityhtml

fatal | error | warning | information

code 11 ValueSethttphl7orgfhirvalueset-issue-typehtml

Error or warning code

details 01 CodeableConcept

ValueSet httphl7orgfhirvalueset-operation-outcomehtml

Additional details about the error

diagnostics 01 string Additional diagnostic information about the issue

location 0 string XPath of element(s) related to issue

425 Using Operation Outcome Resources

On the RESTful interface operation outcome resources are only relevant when a level of computable detail is required that is more granular than that provided by

the HTTP response codes This granularity could include

more detail about the location of an issue

the ability to identify multiple distinct issues

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 13

provision of finer error codes that connect to known business failure states

426 Reporting Errors in the HTTP Headers

Server may also need to report errors in the HTTP headers - especially query parameters when processing searches Errors are reported using a case sensitive

location that has two parts a fixed http and the header or query parameter name separated by a Some examples

Location Description

httpnameexact A reference to the search parameter name with the modifier exact

httpAuthorization A reference to the Authorization header - perhaps to indicate that it is missing and some form of authentication is required

427 OperationOutcome Example - Search

resourceType OperationOutcome

id OperationOutcome1234

issue [

severity fatal

code code-invalid

details

text The name parameter has the modifier exact which is not supported by this server

location [

httpnameexact

]

]

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 14

FHIR Resources 43

DiagnosticReport

PractitionerOrdering Practitioner

Extension ResultCopiestoPractitioners

PatientDiagnosticReportSubject

Organization

PerformingLab

DiagnosticReport

OrganizationReportingLab

ObservationDiagnosticReportResult

SpecimenDiagnosticReportSpecimen

ProcedureRequestDiagnosticReportProcedureRequest

PractitionerAttendingAdmitting

OrganizationExtension

SpecimenCollectorCenter

OrganizationExtension

DestinationLabOrderPlacer

Encounter

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 15

431 Diagnostic Report Profile

ca-on-Diagnostic-DiagnosticReport based on Diagnostic Report profile httphl7orgfhirdiagnosticreporthtml

Name Card Type ValueVocab Description Comments identifier 11 Identifier Identifier assigned by the sending

organization - this is an identifier assigned outside FHIR

This field contains an identifier for the entire order The Placer Group Number is conceptually equivalent to a requisition number assigned to all test requests in an order by an organization (ORC4)

system 11 Uri

The source of the lab reports (ORC43)

value 11 string The unique identifier of the lab report record (ORC41)

status 11 code Value set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

code CodeableConcept

coding 11 coding Fixed code ldquo11502-2rdquo Code defined by a LOINC text 11 string Fixed value ldquoLaboratory Reportrdquo Plain text representation of the concept

Subject (patient)

11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

issued 01 instant dateTime when test request has been issued An instant in time - known at least to the second and always includes a time zone This field will be populated by system (OBR22)

performer 01 Reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

The individual responsible for reporting test result Can be reporting laboratory or reporting practitioner

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 16

Name Card Type ValueVocab Description Comments reference 11 string A reference to a location at which the

other resource is found

request 1 Reference Contained ca-on-Diagnostic-ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

specimen 01 Reference Contained ca-on-Diagnostic-Specimen (Specimen) resource

Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

Result 1 Reference Contained ca-on-Diagnostic-Observation (Observation) resource

List of all the observation associated with the test request (OBX)

reference 11 string A reference to a location at which the other resource is found

codedDiagnosi

s

01 CodeableCon

cept

Value Set ICD10 Diagnosis information

coding 11 coding A reference to a location at which the other resource is found

text 11 string A reference to a location at which the other resource is found

432 Procedure Request Profile

ca-on-Diagnostic-ProcedureRequest profile based on httphl7orgfhirprocedurerequesthtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier assigned by the ordering facility - this is an identifier assigned outside FHIR Must contain a value assigned by the order-placing organization that uniquely identifies this test request among all test requests in OLIS (OBR2)

system 11 Uri The source of test request on the lab report (OBR23)

value 11 string The unique identifier of the test request record (OBR21)

This represents the test request number from the LIS or HIS systems

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 17

Name Card Type ValueVocab Description Comments

status 11 code Value Set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

intent 11 code Value set httphl7orgfhirValueSetrequest-intent

proposal | plan | original-order | order| reflex-order (OBR11)

If OBR11 contains lsquoGrsquo populate lsquoreflex-testrsquo value otherwise fix the value to lsquoOrderrsquo

priority 11 code Value set httphl7orgfhirValueSetrequest-priority

routine | urgent | asap | stat

RequestPriority (Required) (OBR276)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Context (encounter)

11 Reference Contained ca-on-Diagnostic-Encounter (Encounter) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

occuranceDateTime

11 dateTime When testing should occur (OBR274) For routine orders populate this field with the current date

For timing-critical orders populate this field with the date and time that the specimen is to be obtained

For future-dated orders populate this field with the scheduled future date (and time if applicable) when the laboratory test is to occur

extension

01 DateTime of Transaction (ORC9) Populate this field with the

date and time of the event

that initiated the current

transaction

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 18

url 11 httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-dateTime-transaction

valueDateTime 11 dateTime

requester 11 BackboneElement

agent 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the personorganization making request to perform the test (ordering practitionerorganization OBR16)

IF Ordering Facility exists in the message (ORC21) Scenario 1 requester (OBR16) is organization populate ORC21 with the same organization information that in OBR16 field Scenario 2 requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

onBehalfOf 01 reference Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the organization agent is acting for ordering facility

Should be mapped to ordering facility (ORC21 and ORC22) where requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension CCrsquod list practitioner (OBR28) url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-cc-practitioner-list

valueReference (Practitioner)

110 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Practitioners named on an order (attending admitting ccrsquod)

reference 11 string A reference to a location at which the

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 19

other resource is found extension 01 Extension Test Request Placer ZBR2

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-test-request-placer

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Original Test Request Placer

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension Destination Laboratory ZBR8 url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-destination-laboratory

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Destination Laboratory

reference 11 string A reference to a location at which the other resource is found

note 05 Annotation comments authorString 11 string ZNT segment Indicate the organization

(or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

extension 11 Extension Source of Comment (NTE2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-source-comment

valueString

11 string

extension 11 Extension Set ID (NTE1)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 20

set-id

valueString

11 string

433 Observation Profile

ca-on-Diagnostic-Observation profile based on httphl7orgfhirobservationhtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Unique ID for the particular observation (OBR3)

system 11 uri The namespace for the identifier (OBR32) value 11 string The value that is unique (OBR31)

status 11 code Value set Observation result status (OBX11) code CodeableCo

ncept Value set LOINCSNOMED CT

Test result code (OBX3)

coding 11 coding Code defined by a terminology system (OBX31)

text 11 string Plain text representation of the concept (OBX32)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

effective 01 Clinically relevant time for observation

effectiveDateTime

01 dateTime DateTime of observation OBX141 Use this field for ancillary order only

This field must be empty when a laboratory reports a test result

issued 11 instant Indicate the date and time that the Test Result was released by the Reporting Laboratory (ZBX1)

performer (organization)

11 Reference Contained ca-on-Deagnostic-Organization (Organization) Resource or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

The individual responsible for performing the test Can be laboratory or practitioner

reference 11 string A reference to a location at which the other resource is found

value 11 Actual result

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 21

Name Card Type ValueVocab Description Comments

valueQuantity 11 Quantity (OBX2)-Only numeric test value value 11 decimal Numeric value of the test result (OBX5) unit 01 string When observation Value is a scalar value this

field describes the units of measure (OBX61)

interpretation 01 CodebaleConcept

Observation Interpretation Codes(OBX8)

coding 01 Coding Value set method 01 CodebaleCo

ncept How the observation has been done (OBX17)

text 11 string Plain text (OBX172) specimen 01 Reference Contained ca-on-Diagnostic-

Specimen (Specimen) resource Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

referenceRange 01 BackboneElement

Normal range of value associated with observation result (OBX7)

text 11 string Text based reference range in an observation

extension 01 Extension Nature of Abnormal Test (OBX10)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-nature-abnormal-test

valuecoding

11 coding Value set

extension 01 Extension Observation sub-id (OBX4)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation sort key (ZBX2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation comment (NTE-ZNT)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 22

url 11 uri httpehealthontariocaAPIfhir

StructureDefinitiondiagnosticReport-ext-observation-comment

valueAnnotation

11 annotation

authorString

11 string ZNT segment Indicate the organization (or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

434 Specimen Profile

ca-on-Diagnostic-Specimen profile based on httphl7orgfhirspecimenhtml

Name Card Type ValueVocab Description Comments

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

receivedTime 11 dateTime The time when specimen was received for processing

OBR14

request 1 Reference Contained ca-on-Diagnostic- ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

extension 11 Extension Organization that collected the specimen

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-specimen-collector-center

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Specimen Collector Center (ZBR3)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 23

Name Card Type ValueVocab Description Comments

Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

reference 11 string A reference to a location at which the other resource is found

reference 11 string A reference to a location at which the other resource is found

collected 01 Specimen collection time CollectedPeriod 11 Period

start 01 dateTime Starting specimen time OBR7 end 01 dateTime End specimen time OBR8

type 01 CodeableConcept

Kind of material that forms the specimen (Specimen Type)

OBR15

coding 01 coding Value Set from OLIS Code define by the terminology system

OBR1511

text 01 string Plain text representation of the concept

OBR1512

bodySite 01 CodeableConcept

Value Set Anatomical collection site OBR155

container 01 BackboneElement

Direct container of specimen

identifier 02 identifier Id for container OBR18 andor OBR20 Referring Lab User Specimen Identifier and Performing Lab User Specimen Identifier on Refereed ndashout orders

specimenQuantity

01 SimpleQuantity

Quantity of specimen within container

OBR37

note 01 Annotation Collectors comments text 11 string Collectors comments OBR39

extension 01 Extension Collection volume (OBR9)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-collection-volume

valueQuantity

11 Quantity

value 11 decimal Numeric value of the collection OBR91

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 24

volume unit 01 string Units of measure OBR921

435 Patient Profile

ca-on-Diagnostic-Patient profile based on httphl7orgfhirpatienthtml

Name

Card Type ValueVocab Description Comment

identifier

1 Identifier An identifier for this patient

system 11 uri [id-system-global-base]ca-on-patient-hcn

Patient Identifier Assigning Authority Namespace in which set of possible id values is unique (PID391 PID392 PID393)

Value 11 string Patient Identifier Number The portion of the identifier typically displayed to the user and which is unique within the context of the system (PID31)

extension 01 Health Card Version code (PID311) this is an extension patient identifier

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionext-identifier-hcn-version-code

valueString 11 string name

01 HumanName

use 11 code Value set httphl7orgfhirValueSetname-use

Purpose of this name Name type code PID57

Fix to the official for all cases except for anonymous For anonymous code should be lsquoanonymousrsquo

family 11 string Patient Last Name (PID51) given 02 string Patient First Name(PID52) extension 01 patient middle name (PID53)

this is an extension of given name

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode 11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name (PID55)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 25

Name

Card Type ValueVocab Description Comment

suffix 02 String Parts that come after the name (PID54)

extension 01 Patient degree designation This is an extension of suffix

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoACrdquo Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

telecom 03 Demographics Patient table Telephone Number system 01 code httphl7orgfhir

ValueSetcontact-point-system

Telecommunications form for contact point (Phone fax email pager url sms other) PID133 or PID143

Value 11 string The actual contact point details PID134-PID138 Or PID144-PID148

use 01 code httphl7orgfhirValueSetcontact-point-use

Use of contact point (Home work temp old mobile) PID132 or PID142

gender 11 code ldquomalerdquo ldquofemalerdquo ldquootherrdquo ldquounknownrdquo (httphl7orgfhirValueSetadministrative-gender)

The gender of a person used for administrative purposes (PID8)

birthDate 11 date The date of birth for the individual (PID7) Deceased[x]

01 boolean|dateTime

Indicates if the individual is deceased or not The value must be one of the choices specified below but not both System creating instance of this resource must decide which type to use at run time (PID30)

deceasedBoolean

boolean true|false

deceasedDateTime

dateTime Deceased datetime if known (PID29)

address 12 Address Demographics Patient table Address for the individual (PID11)

use 11 code ValueSet httphl7orgfhir

Address Type The use of an address

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 26

Name

Card Type ValueVocab Description Comment

ValueSetaddress-use

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

line 11 string Street lines (PID111) city 11 string Name of city town etc (PID113) state 01 string Province or territory (PID114) postalCode 01 string Postal code for area (PID115) country 11 string Country (can be ISO 3166 3 letter code) (PID116)

436 Practitioner Profile (Ordering Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent Ordering Practitioner information

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR1622

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR161

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR162 given 12 string Practitioner First Name OBR163

extension

01 Practitioner middle name this is an extension of given name

OBR164

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 16: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 13

provision of finer error codes that connect to known business failure states

426 Reporting Errors in the HTTP Headers

Server may also need to report errors in the HTTP headers - especially query parameters when processing searches Errors are reported using a case sensitive

location that has two parts a fixed http and the header or query parameter name separated by a Some examples

Location Description

httpnameexact A reference to the search parameter name with the modifier exact

httpAuthorization A reference to the Authorization header - perhaps to indicate that it is missing and some form of authentication is required

427 OperationOutcome Example - Search

resourceType OperationOutcome

id OperationOutcome1234

issue [

severity fatal

code code-invalid

details

text The name parameter has the modifier exact which is not supported by this server

location [

httpnameexact

]

]

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 14

FHIR Resources 43

DiagnosticReport

PractitionerOrdering Practitioner

Extension ResultCopiestoPractitioners

PatientDiagnosticReportSubject

Organization

PerformingLab

DiagnosticReport

OrganizationReportingLab

ObservationDiagnosticReportResult

SpecimenDiagnosticReportSpecimen

ProcedureRequestDiagnosticReportProcedureRequest

PractitionerAttendingAdmitting

OrganizationExtension

SpecimenCollectorCenter

OrganizationExtension

DestinationLabOrderPlacer

Encounter

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 15

431 Diagnostic Report Profile

ca-on-Diagnostic-DiagnosticReport based on Diagnostic Report profile httphl7orgfhirdiagnosticreporthtml

Name Card Type ValueVocab Description Comments identifier 11 Identifier Identifier assigned by the sending

organization - this is an identifier assigned outside FHIR

This field contains an identifier for the entire order The Placer Group Number is conceptually equivalent to a requisition number assigned to all test requests in an order by an organization (ORC4)

system 11 Uri

The source of the lab reports (ORC43)

value 11 string The unique identifier of the lab report record (ORC41)

status 11 code Value set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

code CodeableConcept

coding 11 coding Fixed code ldquo11502-2rdquo Code defined by a LOINC text 11 string Fixed value ldquoLaboratory Reportrdquo Plain text representation of the concept

Subject (patient)

11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

issued 01 instant dateTime when test request has been issued An instant in time - known at least to the second and always includes a time zone This field will be populated by system (OBR22)

performer 01 Reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

The individual responsible for reporting test result Can be reporting laboratory or reporting practitioner

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 16

Name Card Type ValueVocab Description Comments reference 11 string A reference to a location at which the

other resource is found

request 1 Reference Contained ca-on-Diagnostic-ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

specimen 01 Reference Contained ca-on-Diagnostic-Specimen (Specimen) resource

Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

Result 1 Reference Contained ca-on-Diagnostic-Observation (Observation) resource

List of all the observation associated with the test request (OBX)

reference 11 string A reference to a location at which the other resource is found

codedDiagnosi

s

01 CodeableCon

cept

Value Set ICD10 Diagnosis information

coding 11 coding A reference to a location at which the other resource is found

text 11 string A reference to a location at which the other resource is found

432 Procedure Request Profile

ca-on-Diagnostic-ProcedureRequest profile based on httphl7orgfhirprocedurerequesthtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier assigned by the ordering facility - this is an identifier assigned outside FHIR Must contain a value assigned by the order-placing organization that uniquely identifies this test request among all test requests in OLIS (OBR2)

system 11 Uri The source of test request on the lab report (OBR23)

value 11 string The unique identifier of the test request record (OBR21)

This represents the test request number from the LIS or HIS systems

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 17

Name Card Type ValueVocab Description Comments

status 11 code Value Set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

intent 11 code Value set httphl7orgfhirValueSetrequest-intent

proposal | plan | original-order | order| reflex-order (OBR11)

If OBR11 contains lsquoGrsquo populate lsquoreflex-testrsquo value otherwise fix the value to lsquoOrderrsquo

priority 11 code Value set httphl7orgfhirValueSetrequest-priority

routine | urgent | asap | stat

RequestPriority (Required) (OBR276)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Context (encounter)

11 Reference Contained ca-on-Diagnostic-Encounter (Encounter) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

occuranceDateTime

11 dateTime When testing should occur (OBR274) For routine orders populate this field with the current date

For timing-critical orders populate this field with the date and time that the specimen is to be obtained

For future-dated orders populate this field with the scheduled future date (and time if applicable) when the laboratory test is to occur

extension

01 DateTime of Transaction (ORC9) Populate this field with the

date and time of the event

that initiated the current

transaction

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 18

url 11 httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-dateTime-transaction

valueDateTime 11 dateTime

requester 11 BackboneElement

agent 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the personorganization making request to perform the test (ordering practitionerorganization OBR16)

IF Ordering Facility exists in the message (ORC21) Scenario 1 requester (OBR16) is organization populate ORC21 with the same organization information that in OBR16 field Scenario 2 requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

onBehalfOf 01 reference Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the organization agent is acting for ordering facility

Should be mapped to ordering facility (ORC21 and ORC22) where requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension CCrsquod list practitioner (OBR28) url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-cc-practitioner-list

valueReference (Practitioner)

110 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Practitioners named on an order (attending admitting ccrsquod)

reference 11 string A reference to a location at which the

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 19

other resource is found extension 01 Extension Test Request Placer ZBR2

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-test-request-placer

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Original Test Request Placer

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension Destination Laboratory ZBR8 url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-destination-laboratory

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Destination Laboratory

reference 11 string A reference to a location at which the other resource is found

note 05 Annotation comments authorString 11 string ZNT segment Indicate the organization

(or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

extension 11 Extension Source of Comment (NTE2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-source-comment

valueString

11 string

extension 11 Extension Set ID (NTE1)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 20

set-id

valueString

11 string

433 Observation Profile

ca-on-Diagnostic-Observation profile based on httphl7orgfhirobservationhtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Unique ID for the particular observation (OBR3)

system 11 uri The namespace for the identifier (OBR32) value 11 string The value that is unique (OBR31)

status 11 code Value set Observation result status (OBX11) code CodeableCo

ncept Value set LOINCSNOMED CT

Test result code (OBX3)

coding 11 coding Code defined by a terminology system (OBX31)

text 11 string Plain text representation of the concept (OBX32)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

effective 01 Clinically relevant time for observation

effectiveDateTime

01 dateTime DateTime of observation OBX141 Use this field for ancillary order only

This field must be empty when a laboratory reports a test result

issued 11 instant Indicate the date and time that the Test Result was released by the Reporting Laboratory (ZBX1)

performer (organization)

11 Reference Contained ca-on-Deagnostic-Organization (Organization) Resource or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

The individual responsible for performing the test Can be laboratory or practitioner

reference 11 string A reference to a location at which the other resource is found

value 11 Actual result

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 21

Name Card Type ValueVocab Description Comments

valueQuantity 11 Quantity (OBX2)-Only numeric test value value 11 decimal Numeric value of the test result (OBX5) unit 01 string When observation Value is a scalar value this

field describes the units of measure (OBX61)

interpretation 01 CodebaleConcept

Observation Interpretation Codes(OBX8)

coding 01 Coding Value set method 01 CodebaleCo

ncept How the observation has been done (OBX17)

text 11 string Plain text (OBX172) specimen 01 Reference Contained ca-on-Diagnostic-

Specimen (Specimen) resource Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

referenceRange 01 BackboneElement

Normal range of value associated with observation result (OBX7)

text 11 string Text based reference range in an observation

extension 01 Extension Nature of Abnormal Test (OBX10)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-nature-abnormal-test

valuecoding

11 coding Value set

extension 01 Extension Observation sub-id (OBX4)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation sort key (ZBX2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation comment (NTE-ZNT)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 22

url 11 uri httpehealthontariocaAPIfhir

StructureDefinitiondiagnosticReport-ext-observation-comment

valueAnnotation

11 annotation

authorString

11 string ZNT segment Indicate the organization (or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

434 Specimen Profile

ca-on-Diagnostic-Specimen profile based on httphl7orgfhirspecimenhtml

Name Card Type ValueVocab Description Comments

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

receivedTime 11 dateTime The time when specimen was received for processing

OBR14

request 1 Reference Contained ca-on-Diagnostic- ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

extension 11 Extension Organization that collected the specimen

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-specimen-collector-center

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Specimen Collector Center (ZBR3)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 23

Name Card Type ValueVocab Description Comments

Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

reference 11 string A reference to a location at which the other resource is found

reference 11 string A reference to a location at which the other resource is found

collected 01 Specimen collection time CollectedPeriod 11 Period

start 01 dateTime Starting specimen time OBR7 end 01 dateTime End specimen time OBR8

type 01 CodeableConcept

Kind of material that forms the specimen (Specimen Type)

OBR15

coding 01 coding Value Set from OLIS Code define by the terminology system

OBR1511

text 01 string Plain text representation of the concept

OBR1512

bodySite 01 CodeableConcept

Value Set Anatomical collection site OBR155

container 01 BackboneElement

Direct container of specimen

identifier 02 identifier Id for container OBR18 andor OBR20 Referring Lab User Specimen Identifier and Performing Lab User Specimen Identifier on Refereed ndashout orders

specimenQuantity

01 SimpleQuantity

Quantity of specimen within container

OBR37

note 01 Annotation Collectors comments text 11 string Collectors comments OBR39

extension 01 Extension Collection volume (OBR9)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-collection-volume

valueQuantity

11 Quantity

value 11 decimal Numeric value of the collection OBR91

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 24

volume unit 01 string Units of measure OBR921

435 Patient Profile

ca-on-Diagnostic-Patient profile based on httphl7orgfhirpatienthtml

Name

Card Type ValueVocab Description Comment

identifier

1 Identifier An identifier for this patient

system 11 uri [id-system-global-base]ca-on-patient-hcn

Patient Identifier Assigning Authority Namespace in which set of possible id values is unique (PID391 PID392 PID393)

Value 11 string Patient Identifier Number The portion of the identifier typically displayed to the user and which is unique within the context of the system (PID31)

extension 01 Health Card Version code (PID311) this is an extension patient identifier

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionext-identifier-hcn-version-code

valueString 11 string name

01 HumanName

use 11 code Value set httphl7orgfhirValueSetname-use

Purpose of this name Name type code PID57

Fix to the official for all cases except for anonymous For anonymous code should be lsquoanonymousrsquo

family 11 string Patient Last Name (PID51) given 02 string Patient First Name(PID52) extension 01 patient middle name (PID53)

this is an extension of given name

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode 11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name (PID55)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 25

Name

Card Type ValueVocab Description Comment

suffix 02 String Parts that come after the name (PID54)

extension 01 Patient degree designation This is an extension of suffix

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoACrdquo Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

telecom 03 Demographics Patient table Telephone Number system 01 code httphl7orgfhir

ValueSetcontact-point-system

Telecommunications form for contact point (Phone fax email pager url sms other) PID133 or PID143

Value 11 string The actual contact point details PID134-PID138 Or PID144-PID148

use 01 code httphl7orgfhirValueSetcontact-point-use

Use of contact point (Home work temp old mobile) PID132 or PID142

gender 11 code ldquomalerdquo ldquofemalerdquo ldquootherrdquo ldquounknownrdquo (httphl7orgfhirValueSetadministrative-gender)

The gender of a person used for administrative purposes (PID8)

birthDate 11 date The date of birth for the individual (PID7) Deceased[x]

01 boolean|dateTime

Indicates if the individual is deceased or not The value must be one of the choices specified below but not both System creating instance of this resource must decide which type to use at run time (PID30)

deceasedBoolean

boolean true|false

deceasedDateTime

dateTime Deceased datetime if known (PID29)

address 12 Address Demographics Patient table Address for the individual (PID11)

use 11 code ValueSet httphl7orgfhir

Address Type The use of an address

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 26

Name

Card Type ValueVocab Description Comment

ValueSetaddress-use

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

line 11 string Street lines (PID111) city 11 string Name of city town etc (PID113) state 01 string Province or territory (PID114) postalCode 01 string Postal code for area (PID115) country 11 string Country (can be ISO 3166 3 letter code) (PID116)

436 Practitioner Profile (Ordering Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent Ordering Practitioner information

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR1622

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR161

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR162 given 12 string Practitioner First Name OBR163

extension

01 Practitioner middle name this is an extension of given name

OBR164

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 17: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 14

FHIR Resources 43

DiagnosticReport

PractitionerOrdering Practitioner

Extension ResultCopiestoPractitioners

PatientDiagnosticReportSubject

Organization

PerformingLab

DiagnosticReport

OrganizationReportingLab

ObservationDiagnosticReportResult

SpecimenDiagnosticReportSpecimen

ProcedureRequestDiagnosticReportProcedureRequest

PractitionerAttendingAdmitting

OrganizationExtension

SpecimenCollectorCenter

OrganizationExtension

DestinationLabOrderPlacer

Encounter

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 15

431 Diagnostic Report Profile

ca-on-Diagnostic-DiagnosticReport based on Diagnostic Report profile httphl7orgfhirdiagnosticreporthtml

Name Card Type ValueVocab Description Comments identifier 11 Identifier Identifier assigned by the sending

organization - this is an identifier assigned outside FHIR

This field contains an identifier for the entire order The Placer Group Number is conceptually equivalent to a requisition number assigned to all test requests in an order by an organization (ORC4)

system 11 Uri

The source of the lab reports (ORC43)

value 11 string The unique identifier of the lab report record (ORC41)

status 11 code Value set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

code CodeableConcept

coding 11 coding Fixed code ldquo11502-2rdquo Code defined by a LOINC text 11 string Fixed value ldquoLaboratory Reportrdquo Plain text representation of the concept

Subject (patient)

11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

issued 01 instant dateTime when test request has been issued An instant in time - known at least to the second and always includes a time zone This field will be populated by system (OBR22)

performer 01 Reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

The individual responsible for reporting test result Can be reporting laboratory or reporting practitioner

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 16

Name Card Type ValueVocab Description Comments reference 11 string A reference to a location at which the

other resource is found

request 1 Reference Contained ca-on-Diagnostic-ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

specimen 01 Reference Contained ca-on-Diagnostic-Specimen (Specimen) resource

Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

Result 1 Reference Contained ca-on-Diagnostic-Observation (Observation) resource

List of all the observation associated with the test request (OBX)

reference 11 string A reference to a location at which the other resource is found

codedDiagnosi

s

01 CodeableCon

cept

Value Set ICD10 Diagnosis information

coding 11 coding A reference to a location at which the other resource is found

text 11 string A reference to a location at which the other resource is found

432 Procedure Request Profile

ca-on-Diagnostic-ProcedureRequest profile based on httphl7orgfhirprocedurerequesthtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier assigned by the ordering facility - this is an identifier assigned outside FHIR Must contain a value assigned by the order-placing organization that uniquely identifies this test request among all test requests in OLIS (OBR2)

system 11 Uri The source of test request on the lab report (OBR23)

value 11 string The unique identifier of the test request record (OBR21)

This represents the test request number from the LIS or HIS systems

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 17

Name Card Type ValueVocab Description Comments

status 11 code Value Set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

intent 11 code Value set httphl7orgfhirValueSetrequest-intent

proposal | plan | original-order | order| reflex-order (OBR11)

If OBR11 contains lsquoGrsquo populate lsquoreflex-testrsquo value otherwise fix the value to lsquoOrderrsquo

priority 11 code Value set httphl7orgfhirValueSetrequest-priority

routine | urgent | asap | stat

RequestPriority (Required) (OBR276)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Context (encounter)

11 Reference Contained ca-on-Diagnostic-Encounter (Encounter) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

occuranceDateTime

11 dateTime When testing should occur (OBR274) For routine orders populate this field with the current date

For timing-critical orders populate this field with the date and time that the specimen is to be obtained

For future-dated orders populate this field with the scheduled future date (and time if applicable) when the laboratory test is to occur

extension

01 DateTime of Transaction (ORC9) Populate this field with the

date and time of the event

that initiated the current

transaction

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 18

url 11 httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-dateTime-transaction

valueDateTime 11 dateTime

requester 11 BackboneElement

agent 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the personorganization making request to perform the test (ordering practitionerorganization OBR16)

IF Ordering Facility exists in the message (ORC21) Scenario 1 requester (OBR16) is organization populate ORC21 with the same organization information that in OBR16 field Scenario 2 requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

onBehalfOf 01 reference Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the organization agent is acting for ordering facility

Should be mapped to ordering facility (ORC21 and ORC22) where requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension CCrsquod list practitioner (OBR28) url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-cc-practitioner-list

valueReference (Practitioner)

110 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Practitioners named on an order (attending admitting ccrsquod)

reference 11 string A reference to a location at which the

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 19

other resource is found extension 01 Extension Test Request Placer ZBR2

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-test-request-placer

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Original Test Request Placer

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension Destination Laboratory ZBR8 url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-destination-laboratory

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Destination Laboratory

reference 11 string A reference to a location at which the other resource is found

note 05 Annotation comments authorString 11 string ZNT segment Indicate the organization

(or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

extension 11 Extension Source of Comment (NTE2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-source-comment

valueString

11 string

extension 11 Extension Set ID (NTE1)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 20

set-id

valueString

11 string

433 Observation Profile

ca-on-Diagnostic-Observation profile based on httphl7orgfhirobservationhtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Unique ID for the particular observation (OBR3)

system 11 uri The namespace for the identifier (OBR32) value 11 string The value that is unique (OBR31)

status 11 code Value set Observation result status (OBX11) code CodeableCo

ncept Value set LOINCSNOMED CT

Test result code (OBX3)

coding 11 coding Code defined by a terminology system (OBX31)

text 11 string Plain text representation of the concept (OBX32)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

effective 01 Clinically relevant time for observation

effectiveDateTime

01 dateTime DateTime of observation OBX141 Use this field for ancillary order only

This field must be empty when a laboratory reports a test result

issued 11 instant Indicate the date and time that the Test Result was released by the Reporting Laboratory (ZBX1)

performer (organization)

11 Reference Contained ca-on-Deagnostic-Organization (Organization) Resource or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

The individual responsible for performing the test Can be laboratory or practitioner

reference 11 string A reference to a location at which the other resource is found

value 11 Actual result

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 21

Name Card Type ValueVocab Description Comments

valueQuantity 11 Quantity (OBX2)-Only numeric test value value 11 decimal Numeric value of the test result (OBX5) unit 01 string When observation Value is a scalar value this

field describes the units of measure (OBX61)

interpretation 01 CodebaleConcept

Observation Interpretation Codes(OBX8)

coding 01 Coding Value set method 01 CodebaleCo

ncept How the observation has been done (OBX17)

text 11 string Plain text (OBX172) specimen 01 Reference Contained ca-on-Diagnostic-

Specimen (Specimen) resource Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

referenceRange 01 BackboneElement

Normal range of value associated with observation result (OBX7)

text 11 string Text based reference range in an observation

extension 01 Extension Nature of Abnormal Test (OBX10)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-nature-abnormal-test

valuecoding

11 coding Value set

extension 01 Extension Observation sub-id (OBX4)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation sort key (ZBX2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation comment (NTE-ZNT)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 22

url 11 uri httpehealthontariocaAPIfhir

StructureDefinitiondiagnosticReport-ext-observation-comment

valueAnnotation

11 annotation

authorString

11 string ZNT segment Indicate the organization (or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

434 Specimen Profile

ca-on-Diagnostic-Specimen profile based on httphl7orgfhirspecimenhtml

Name Card Type ValueVocab Description Comments

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

receivedTime 11 dateTime The time when specimen was received for processing

OBR14

request 1 Reference Contained ca-on-Diagnostic- ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

extension 11 Extension Organization that collected the specimen

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-specimen-collector-center

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Specimen Collector Center (ZBR3)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 23

Name Card Type ValueVocab Description Comments

Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

reference 11 string A reference to a location at which the other resource is found

reference 11 string A reference to a location at which the other resource is found

collected 01 Specimen collection time CollectedPeriod 11 Period

start 01 dateTime Starting specimen time OBR7 end 01 dateTime End specimen time OBR8

type 01 CodeableConcept

Kind of material that forms the specimen (Specimen Type)

OBR15

coding 01 coding Value Set from OLIS Code define by the terminology system

OBR1511

text 01 string Plain text representation of the concept

OBR1512

bodySite 01 CodeableConcept

Value Set Anatomical collection site OBR155

container 01 BackboneElement

Direct container of specimen

identifier 02 identifier Id for container OBR18 andor OBR20 Referring Lab User Specimen Identifier and Performing Lab User Specimen Identifier on Refereed ndashout orders

specimenQuantity

01 SimpleQuantity

Quantity of specimen within container

OBR37

note 01 Annotation Collectors comments text 11 string Collectors comments OBR39

extension 01 Extension Collection volume (OBR9)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-collection-volume

valueQuantity

11 Quantity

value 11 decimal Numeric value of the collection OBR91

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 24

volume unit 01 string Units of measure OBR921

435 Patient Profile

ca-on-Diagnostic-Patient profile based on httphl7orgfhirpatienthtml

Name

Card Type ValueVocab Description Comment

identifier

1 Identifier An identifier for this patient

system 11 uri [id-system-global-base]ca-on-patient-hcn

Patient Identifier Assigning Authority Namespace in which set of possible id values is unique (PID391 PID392 PID393)

Value 11 string Patient Identifier Number The portion of the identifier typically displayed to the user and which is unique within the context of the system (PID31)

extension 01 Health Card Version code (PID311) this is an extension patient identifier

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionext-identifier-hcn-version-code

valueString 11 string name

01 HumanName

use 11 code Value set httphl7orgfhirValueSetname-use

Purpose of this name Name type code PID57

Fix to the official for all cases except for anonymous For anonymous code should be lsquoanonymousrsquo

family 11 string Patient Last Name (PID51) given 02 string Patient First Name(PID52) extension 01 patient middle name (PID53)

this is an extension of given name

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode 11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name (PID55)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 25

Name

Card Type ValueVocab Description Comment

suffix 02 String Parts that come after the name (PID54)

extension 01 Patient degree designation This is an extension of suffix

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoACrdquo Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

telecom 03 Demographics Patient table Telephone Number system 01 code httphl7orgfhir

ValueSetcontact-point-system

Telecommunications form for contact point (Phone fax email pager url sms other) PID133 or PID143

Value 11 string The actual contact point details PID134-PID138 Or PID144-PID148

use 01 code httphl7orgfhirValueSetcontact-point-use

Use of contact point (Home work temp old mobile) PID132 or PID142

gender 11 code ldquomalerdquo ldquofemalerdquo ldquootherrdquo ldquounknownrdquo (httphl7orgfhirValueSetadministrative-gender)

The gender of a person used for administrative purposes (PID8)

birthDate 11 date The date of birth for the individual (PID7) Deceased[x]

01 boolean|dateTime

Indicates if the individual is deceased or not The value must be one of the choices specified below but not both System creating instance of this resource must decide which type to use at run time (PID30)

deceasedBoolean

boolean true|false

deceasedDateTime

dateTime Deceased datetime if known (PID29)

address 12 Address Demographics Patient table Address for the individual (PID11)

use 11 code ValueSet httphl7orgfhir

Address Type The use of an address

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 26

Name

Card Type ValueVocab Description Comment

ValueSetaddress-use

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

line 11 string Street lines (PID111) city 11 string Name of city town etc (PID113) state 01 string Province or territory (PID114) postalCode 01 string Postal code for area (PID115) country 11 string Country (can be ISO 3166 3 letter code) (PID116)

436 Practitioner Profile (Ordering Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent Ordering Practitioner information

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR1622

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR161

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR162 given 12 string Practitioner First Name OBR163

extension

01 Practitioner middle name this is an extension of given name

OBR164

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 18: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 15

431 Diagnostic Report Profile

ca-on-Diagnostic-DiagnosticReport based on Diagnostic Report profile httphl7orgfhirdiagnosticreporthtml

Name Card Type ValueVocab Description Comments identifier 11 Identifier Identifier assigned by the sending

organization - this is an identifier assigned outside FHIR

This field contains an identifier for the entire order The Placer Group Number is conceptually equivalent to a requisition number assigned to all test requests in an order by an organization (ORC4)

system 11 Uri

The source of the lab reports (ORC43)

value 11 string The unique identifier of the lab report record (ORC41)

status 11 code Value set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

code CodeableConcept

coding 11 coding Fixed code ldquo11502-2rdquo Code defined by a LOINC text 11 string Fixed value ldquoLaboratory Reportrdquo Plain text representation of the concept

Subject (patient)

11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

issued 01 instant dateTime when test request has been issued An instant in time - known at least to the second and always includes a time zone This field will be populated by system (OBR22)

performer 01 Reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

The individual responsible for reporting test result Can be reporting laboratory or reporting practitioner

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 16

Name Card Type ValueVocab Description Comments reference 11 string A reference to a location at which the

other resource is found

request 1 Reference Contained ca-on-Diagnostic-ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

specimen 01 Reference Contained ca-on-Diagnostic-Specimen (Specimen) resource

Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

Result 1 Reference Contained ca-on-Diagnostic-Observation (Observation) resource

List of all the observation associated with the test request (OBX)

reference 11 string A reference to a location at which the other resource is found

codedDiagnosi

s

01 CodeableCon

cept

Value Set ICD10 Diagnosis information

coding 11 coding A reference to a location at which the other resource is found

text 11 string A reference to a location at which the other resource is found

432 Procedure Request Profile

ca-on-Diagnostic-ProcedureRequest profile based on httphl7orgfhirprocedurerequesthtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier assigned by the ordering facility - this is an identifier assigned outside FHIR Must contain a value assigned by the order-placing organization that uniquely identifies this test request among all test requests in OLIS (OBR2)

system 11 Uri The source of test request on the lab report (OBR23)

value 11 string The unique identifier of the test request record (OBR21)

This represents the test request number from the LIS or HIS systems

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 17

Name Card Type ValueVocab Description Comments

status 11 code Value Set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

intent 11 code Value set httphl7orgfhirValueSetrequest-intent

proposal | plan | original-order | order| reflex-order (OBR11)

If OBR11 contains lsquoGrsquo populate lsquoreflex-testrsquo value otherwise fix the value to lsquoOrderrsquo

priority 11 code Value set httphl7orgfhirValueSetrequest-priority

routine | urgent | asap | stat

RequestPriority (Required) (OBR276)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Context (encounter)

11 Reference Contained ca-on-Diagnostic-Encounter (Encounter) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

occuranceDateTime

11 dateTime When testing should occur (OBR274) For routine orders populate this field with the current date

For timing-critical orders populate this field with the date and time that the specimen is to be obtained

For future-dated orders populate this field with the scheduled future date (and time if applicable) when the laboratory test is to occur

extension

01 DateTime of Transaction (ORC9) Populate this field with the

date and time of the event

that initiated the current

transaction

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 18

url 11 httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-dateTime-transaction

valueDateTime 11 dateTime

requester 11 BackboneElement

agent 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the personorganization making request to perform the test (ordering practitionerorganization OBR16)

IF Ordering Facility exists in the message (ORC21) Scenario 1 requester (OBR16) is organization populate ORC21 with the same organization information that in OBR16 field Scenario 2 requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

onBehalfOf 01 reference Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the organization agent is acting for ordering facility

Should be mapped to ordering facility (ORC21 and ORC22) where requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension CCrsquod list practitioner (OBR28) url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-cc-practitioner-list

valueReference (Practitioner)

110 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Practitioners named on an order (attending admitting ccrsquod)

reference 11 string A reference to a location at which the

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 19

other resource is found extension 01 Extension Test Request Placer ZBR2

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-test-request-placer

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Original Test Request Placer

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension Destination Laboratory ZBR8 url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-destination-laboratory

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Destination Laboratory

reference 11 string A reference to a location at which the other resource is found

note 05 Annotation comments authorString 11 string ZNT segment Indicate the organization

(or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

extension 11 Extension Source of Comment (NTE2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-source-comment

valueString

11 string

extension 11 Extension Set ID (NTE1)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 20

set-id

valueString

11 string

433 Observation Profile

ca-on-Diagnostic-Observation profile based on httphl7orgfhirobservationhtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Unique ID for the particular observation (OBR3)

system 11 uri The namespace for the identifier (OBR32) value 11 string The value that is unique (OBR31)

status 11 code Value set Observation result status (OBX11) code CodeableCo

ncept Value set LOINCSNOMED CT

Test result code (OBX3)

coding 11 coding Code defined by a terminology system (OBX31)

text 11 string Plain text representation of the concept (OBX32)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

effective 01 Clinically relevant time for observation

effectiveDateTime

01 dateTime DateTime of observation OBX141 Use this field for ancillary order only

This field must be empty when a laboratory reports a test result

issued 11 instant Indicate the date and time that the Test Result was released by the Reporting Laboratory (ZBX1)

performer (organization)

11 Reference Contained ca-on-Deagnostic-Organization (Organization) Resource or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

The individual responsible for performing the test Can be laboratory or practitioner

reference 11 string A reference to a location at which the other resource is found

value 11 Actual result

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 21

Name Card Type ValueVocab Description Comments

valueQuantity 11 Quantity (OBX2)-Only numeric test value value 11 decimal Numeric value of the test result (OBX5) unit 01 string When observation Value is a scalar value this

field describes the units of measure (OBX61)

interpretation 01 CodebaleConcept

Observation Interpretation Codes(OBX8)

coding 01 Coding Value set method 01 CodebaleCo

ncept How the observation has been done (OBX17)

text 11 string Plain text (OBX172) specimen 01 Reference Contained ca-on-Diagnostic-

Specimen (Specimen) resource Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

referenceRange 01 BackboneElement

Normal range of value associated with observation result (OBX7)

text 11 string Text based reference range in an observation

extension 01 Extension Nature of Abnormal Test (OBX10)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-nature-abnormal-test

valuecoding

11 coding Value set

extension 01 Extension Observation sub-id (OBX4)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation sort key (ZBX2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation comment (NTE-ZNT)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 22

url 11 uri httpehealthontariocaAPIfhir

StructureDefinitiondiagnosticReport-ext-observation-comment

valueAnnotation

11 annotation

authorString

11 string ZNT segment Indicate the organization (or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

434 Specimen Profile

ca-on-Diagnostic-Specimen profile based on httphl7orgfhirspecimenhtml

Name Card Type ValueVocab Description Comments

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

receivedTime 11 dateTime The time when specimen was received for processing

OBR14

request 1 Reference Contained ca-on-Diagnostic- ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

extension 11 Extension Organization that collected the specimen

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-specimen-collector-center

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Specimen Collector Center (ZBR3)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 23

Name Card Type ValueVocab Description Comments

Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

reference 11 string A reference to a location at which the other resource is found

reference 11 string A reference to a location at which the other resource is found

collected 01 Specimen collection time CollectedPeriod 11 Period

start 01 dateTime Starting specimen time OBR7 end 01 dateTime End specimen time OBR8

type 01 CodeableConcept

Kind of material that forms the specimen (Specimen Type)

OBR15

coding 01 coding Value Set from OLIS Code define by the terminology system

OBR1511

text 01 string Plain text representation of the concept

OBR1512

bodySite 01 CodeableConcept

Value Set Anatomical collection site OBR155

container 01 BackboneElement

Direct container of specimen

identifier 02 identifier Id for container OBR18 andor OBR20 Referring Lab User Specimen Identifier and Performing Lab User Specimen Identifier on Refereed ndashout orders

specimenQuantity

01 SimpleQuantity

Quantity of specimen within container

OBR37

note 01 Annotation Collectors comments text 11 string Collectors comments OBR39

extension 01 Extension Collection volume (OBR9)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-collection-volume

valueQuantity

11 Quantity

value 11 decimal Numeric value of the collection OBR91

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 24

volume unit 01 string Units of measure OBR921

435 Patient Profile

ca-on-Diagnostic-Patient profile based on httphl7orgfhirpatienthtml

Name

Card Type ValueVocab Description Comment

identifier

1 Identifier An identifier for this patient

system 11 uri [id-system-global-base]ca-on-patient-hcn

Patient Identifier Assigning Authority Namespace in which set of possible id values is unique (PID391 PID392 PID393)

Value 11 string Patient Identifier Number The portion of the identifier typically displayed to the user and which is unique within the context of the system (PID31)

extension 01 Health Card Version code (PID311) this is an extension patient identifier

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionext-identifier-hcn-version-code

valueString 11 string name

01 HumanName

use 11 code Value set httphl7orgfhirValueSetname-use

Purpose of this name Name type code PID57

Fix to the official for all cases except for anonymous For anonymous code should be lsquoanonymousrsquo

family 11 string Patient Last Name (PID51) given 02 string Patient First Name(PID52) extension 01 patient middle name (PID53)

this is an extension of given name

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode 11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name (PID55)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 25

Name

Card Type ValueVocab Description Comment

suffix 02 String Parts that come after the name (PID54)

extension 01 Patient degree designation This is an extension of suffix

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoACrdquo Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

telecom 03 Demographics Patient table Telephone Number system 01 code httphl7orgfhir

ValueSetcontact-point-system

Telecommunications form for contact point (Phone fax email pager url sms other) PID133 or PID143

Value 11 string The actual contact point details PID134-PID138 Or PID144-PID148

use 01 code httphl7orgfhirValueSetcontact-point-use

Use of contact point (Home work temp old mobile) PID132 or PID142

gender 11 code ldquomalerdquo ldquofemalerdquo ldquootherrdquo ldquounknownrdquo (httphl7orgfhirValueSetadministrative-gender)

The gender of a person used for administrative purposes (PID8)

birthDate 11 date The date of birth for the individual (PID7) Deceased[x]

01 boolean|dateTime

Indicates if the individual is deceased or not The value must be one of the choices specified below but not both System creating instance of this resource must decide which type to use at run time (PID30)

deceasedBoolean

boolean true|false

deceasedDateTime

dateTime Deceased datetime if known (PID29)

address 12 Address Demographics Patient table Address for the individual (PID11)

use 11 code ValueSet httphl7orgfhir

Address Type The use of an address

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 26

Name

Card Type ValueVocab Description Comment

ValueSetaddress-use

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

line 11 string Street lines (PID111) city 11 string Name of city town etc (PID113) state 01 string Province or territory (PID114) postalCode 01 string Postal code for area (PID115) country 11 string Country (can be ISO 3166 3 letter code) (PID116)

436 Practitioner Profile (Ordering Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent Ordering Practitioner information

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR1622

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR161

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR162 given 12 string Practitioner First Name OBR163

extension

01 Practitioner middle name this is an extension of given name

OBR164

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 19: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 16

Name Card Type ValueVocab Description Comments reference 11 string A reference to a location at which the

other resource is found

request 1 Reference Contained ca-on-Diagnostic-ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

specimen 01 Reference Contained ca-on-Diagnostic-Specimen (Specimen) resource

Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

Result 1 Reference Contained ca-on-Diagnostic-Observation (Observation) resource

List of all the observation associated with the test request (OBX)

reference 11 string A reference to a location at which the other resource is found

codedDiagnosi

s

01 CodeableCon

cept

Value Set ICD10 Diagnosis information

coding 11 coding A reference to a location at which the other resource is found

text 11 string A reference to a location at which the other resource is found

432 Procedure Request Profile

ca-on-Diagnostic-ProcedureRequest profile based on httphl7orgfhirprocedurerequesthtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier assigned by the ordering facility - this is an identifier assigned outside FHIR Must contain a value assigned by the order-placing organization that uniquely identifies this test request among all test requests in OLIS (OBR2)

system 11 Uri The source of test request on the lab report (OBR23)

value 11 string The unique identifier of the test request record (OBR21)

This represents the test request number from the LIS or HIS systems

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 17

Name Card Type ValueVocab Description Comments

status 11 code Value Set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

intent 11 code Value set httphl7orgfhirValueSetrequest-intent

proposal | plan | original-order | order| reflex-order (OBR11)

If OBR11 contains lsquoGrsquo populate lsquoreflex-testrsquo value otherwise fix the value to lsquoOrderrsquo

priority 11 code Value set httphl7orgfhirValueSetrequest-priority

routine | urgent | asap | stat

RequestPriority (Required) (OBR276)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Context (encounter)

11 Reference Contained ca-on-Diagnostic-Encounter (Encounter) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

occuranceDateTime

11 dateTime When testing should occur (OBR274) For routine orders populate this field with the current date

For timing-critical orders populate this field with the date and time that the specimen is to be obtained

For future-dated orders populate this field with the scheduled future date (and time if applicable) when the laboratory test is to occur

extension

01 DateTime of Transaction (ORC9) Populate this field with the

date and time of the event

that initiated the current

transaction

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 18

url 11 httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-dateTime-transaction

valueDateTime 11 dateTime

requester 11 BackboneElement

agent 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the personorganization making request to perform the test (ordering practitionerorganization OBR16)

IF Ordering Facility exists in the message (ORC21) Scenario 1 requester (OBR16) is organization populate ORC21 with the same organization information that in OBR16 field Scenario 2 requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

onBehalfOf 01 reference Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the organization agent is acting for ordering facility

Should be mapped to ordering facility (ORC21 and ORC22) where requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension CCrsquod list practitioner (OBR28) url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-cc-practitioner-list

valueReference (Practitioner)

110 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Practitioners named on an order (attending admitting ccrsquod)

reference 11 string A reference to a location at which the

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 19

other resource is found extension 01 Extension Test Request Placer ZBR2

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-test-request-placer

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Original Test Request Placer

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension Destination Laboratory ZBR8 url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-destination-laboratory

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Destination Laboratory

reference 11 string A reference to a location at which the other resource is found

note 05 Annotation comments authorString 11 string ZNT segment Indicate the organization

(or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

extension 11 Extension Source of Comment (NTE2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-source-comment

valueString

11 string

extension 11 Extension Set ID (NTE1)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 20

set-id

valueString

11 string

433 Observation Profile

ca-on-Diagnostic-Observation profile based on httphl7orgfhirobservationhtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Unique ID for the particular observation (OBR3)

system 11 uri The namespace for the identifier (OBR32) value 11 string The value that is unique (OBR31)

status 11 code Value set Observation result status (OBX11) code CodeableCo

ncept Value set LOINCSNOMED CT

Test result code (OBX3)

coding 11 coding Code defined by a terminology system (OBX31)

text 11 string Plain text representation of the concept (OBX32)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

effective 01 Clinically relevant time for observation

effectiveDateTime

01 dateTime DateTime of observation OBX141 Use this field for ancillary order only

This field must be empty when a laboratory reports a test result

issued 11 instant Indicate the date and time that the Test Result was released by the Reporting Laboratory (ZBX1)

performer (organization)

11 Reference Contained ca-on-Deagnostic-Organization (Organization) Resource or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

The individual responsible for performing the test Can be laboratory or practitioner

reference 11 string A reference to a location at which the other resource is found

value 11 Actual result

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 21

Name Card Type ValueVocab Description Comments

valueQuantity 11 Quantity (OBX2)-Only numeric test value value 11 decimal Numeric value of the test result (OBX5) unit 01 string When observation Value is a scalar value this

field describes the units of measure (OBX61)

interpretation 01 CodebaleConcept

Observation Interpretation Codes(OBX8)

coding 01 Coding Value set method 01 CodebaleCo

ncept How the observation has been done (OBX17)

text 11 string Plain text (OBX172) specimen 01 Reference Contained ca-on-Diagnostic-

Specimen (Specimen) resource Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

referenceRange 01 BackboneElement

Normal range of value associated with observation result (OBX7)

text 11 string Text based reference range in an observation

extension 01 Extension Nature of Abnormal Test (OBX10)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-nature-abnormal-test

valuecoding

11 coding Value set

extension 01 Extension Observation sub-id (OBX4)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation sort key (ZBX2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation comment (NTE-ZNT)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 22

url 11 uri httpehealthontariocaAPIfhir

StructureDefinitiondiagnosticReport-ext-observation-comment

valueAnnotation

11 annotation

authorString

11 string ZNT segment Indicate the organization (or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

434 Specimen Profile

ca-on-Diagnostic-Specimen profile based on httphl7orgfhirspecimenhtml

Name Card Type ValueVocab Description Comments

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

receivedTime 11 dateTime The time when specimen was received for processing

OBR14

request 1 Reference Contained ca-on-Diagnostic- ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

extension 11 Extension Organization that collected the specimen

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-specimen-collector-center

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Specimen Collector Center (ZBR3)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 23

Name Card Type ValueVocab Description Comments

Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

reference 11 string A reference to a location at which the other resource is found

reference 11 string A reference to a location at which the other resource is found

collected 01 Specimen collection time CollectedPeriod 11 Period

start 01 dateTime Starting specimen time OBR7 end 01 dateTime End specimen time OBR8

type 01 CodeableConcept

Kind of material that forms the specimen (Specimen Type)

OBR15

coding 01 coding Value Set from OLIS Code define by the terminology system

OBR1511

text 01 string Plain text representation of the concept

OBR1512

bodySite 01 CodeableConcept

Value Set Anatomical collection site OBR155

container 01 BackboneElement

Direct container of specimen

identifier 02 identifier Id for container OBR18 andor OBR20 Referring Lab User Specimen Identifier and Performing Lab User Specimen Identifier on Refereed ndashout orders

specimenQuantity

01 SimpleQuantity

Quantity of specimen within container

OBR37

note 01 Annotation Collectors comments text 11 string Collectors comments OBR39

extension 01 Extension Collection volume (OBR9)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-collection-volume

valueQuantity

11 Quantity

value 11 decimal Numeric value of the collection OBR91

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 24

volume unit 01 string Units of measure OBR921

435 Patient Profile

ca-on-Diagnostic-Patient profile based on httphl7orgfhirpatienthtml

Name

Card Type ValueVocab Description Comment

identifier

1 Identifier An identifier for this patient

system 11 uri [id-system-global-base]ca-on-patient-hcn

Patient Identifier Assigning Authority Namespace in which set of possible id values is unique (PID391 PID392 PID393)

Value 11 string Patient Identifier Number The portion of the identifier typically displayed to the user and which is unique within the context of the system (PID31)

extension 01 Health Card Version code (PID311) this is an extension patient identifier

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionext-identifier-hcn-version-code

valueString 11 string name

01 HumanName

use 11 code Value set httphl7orgfhirValueSetname-use

Purpose of this name Name type code PID57

Fix to the official for all cases except for anonymous For anonymous code should be lsquoanonymousrsquo

family 11 string Patient Last Name (PID51) given 02 string Patient First Name(PID52) extension 01 patient middle name (PID53)

this is an extension of given name

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode 11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name (PID55)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 25

Name

Card Type ValueVocab Description Comment

suffix 02 String Parts that come after the name (PID54)

extension 01 Patient degree designation This is an extension of suffix

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoACrdquo Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

telecom 03 Demographics Patient table Telephone Number system 01 code httphl7orgfhir

ValueSetcontact-point-system

Telecommunications form for contact point (Phone fax email pager url sms other) PID133 or PID143

Value 11 string The actual contact point details PID134-PID138 Or PID144-PID148

use 01 code httphl7orgfhirValueSetcontact-point-use

Use of contact point (Home work temp old mobile) PID132 or PID142

gender 11 code ldquomalerdquo ldquofemalerdquo ldquootherrdquo ldquounknownrdquo (httphl7orgfhirValueSetadministrative-gender)

The gender of a person used for administrative purposes (PID8)

birthDate 11 date The date of birth for the individual (PID7) Deceased[x]

01 boolean|dateTime

Indicates if the individual is deceased or not The value must be one of the choices specified below but not both System creating instance of this resource must decide which type to use at run time (PID30)

deceasedBoolean

boolean true|false

deceasedDateTime

dateTime Deceased datetime if known (PID29)

address 12 Address Demographics Patient table Address for the individual (PID11)

use 11 code ValueSet httphl7orgfhir

Address Type The use of an address

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 26

Name

Card Type ValueVocab Description Comment

ValueSetaddress-use

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

line 11 string Street lines (PID111) city 11 string Name of city town etc (PID113) state 01 string Province or territory (PID114) postalCode 01 string Postal code for area (PID115) country 11 string Country (can be ISO 3166 3 letter code) (PID116)

436 Practitioner Profile (Ordering Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent Ordering Practitioner information

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR1622

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR161

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR162 given 12 string Practitioner First Name OBR163

extension

01 Practitioner middle name this is an extension of given name

OBR164

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 20: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 17

Name Card Type ValueVocab Description Comments

status 11 code Value Set httphl7orgfhirValueSetdiagnostic-report-status

A code specifying the state of the test result event (OBR25)

intent 11 code Value set httphl7orgfhirValueSetrequest-intent

proposal | plan | original-order | order| reflex-order (OBR11)

If OBR11 contains lsquoGrsquo populate lsquoreflex-testrsquo value otherwise fix the value to lsquoOrderrsquo

priority 11 code Value set httphl7orgfhirValueSetrequest-priority

routine | urgent | asap | stat

RequestPriority (Required) (OBR276)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Context (encounter)

11 Reference Contained ca-on-Diagnostic-Encounter (Encounter) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

occuranceDateTime

11 dateTime When testing should occur (OBR274) For routine orders populate this field with the current date

For timing-critical orders populate this field with the date and time that the specimen is to be obtained

For future-dated orders populate this field with the scheduled future date (and time if applicable) when the laboratory test is to occur

extension

01 DateTime of Transaction (ORC9) Populate this field with the

date and time of the event

that initiated the current

transaction

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 18

url 11 httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-dateTime-transaction

valueDateTime 11 dateTime

requester 11 BackboneElement

agent 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the personorganization making request to perform the test (ordering practitionerorganization OBR16)

IF Ordering Facility exists in the message (ORC21) Scenario 1 requester (OBR16) is organization populate ORC21 with the same organization information that in OBR16 field Scenario 2 requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

onBehalfOf 01 reference Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the organization agent is acting for ordering facility

Should be mapped to ordering facility (ORC21 and ORC22) where requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension CCrsquod list practitioner (OBR28) url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-cc-practitioner-list

valueReference (Practitioner)

110 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Practitioners named on an order (attending admitting ccrsquod)

reference 11 string A reference to a location at which the

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 19

other resource is found extension 01 Extension Test Request Placer ZBR2

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-test-request-placer

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Original Test Request Placer

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension Destination Laboratory ZBR8 url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-destination-laboratory

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Destination Laboratory

reference 11 string A reference to a location at which the other resource is found

note 05 Annotation comments authorString 11 string ZNT segment Indicate the organization

(or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

extension 11 Extension Source of Comment (NTE2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-source-comment

valueString

11 string

extension 11 Extension Set ID (NTE1)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 20

set-id

valueString

11 string

433 Observation Profile

ca-on-Diagnostic-Observation profile based on httphl7orgfhirobservationhtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Unique ID for the particular observation (OBR3)

system 11 uri The namespace for the identifier (OBR32) value 11 string The value that is unique (OBR31)

status 11 code Value set Observation result status (OBX11) code CodeableCo

ncept Value set LOINCSNOMED CT

Test result code (OBX3)

coding 11 coding Code defined by a terminology system (OBX31)

text 11 string Plain text representation of the concept (OBX32)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

effective 01 Clinically relevant time for observation

effectiveDateTime

01 dateTime DateTime of observation OBX141 Use this field for ancillary order only

This field must be empty when a laboratory reports a test result

issued 11 instant Indicate the date and time that the Test Result was released by the Reporting Laboratory (ZBX1)

performer (organization)

11 Reference Contained ca-on-Deagnostic-Organization (Organization) Resource or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

The individual responsible for performing the test Can be laboratory or practitioner

reference 11 string A reference to a location at which the other resource is found

value 11 Actual result

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 21

Name Card Type ValueVocab Description Comments

valueQuantity 11 Quantity (OBX2)-Only numeric test value value 11 decimal Numeric value of the test result (OBX5) unit 01 string When observation Value is a scalar value this

field describes the units of measure (OBX61)

interpretation 01 CodebaleConcept

Observation Interpretation Codes(OBX8)

coding 01 Coding Value set method 01 CodebaleCo

ncept How the observation has been done (OBX17)

text 11 string Plain text (OBX172) specimen 01 Reference Contained ca-on-Diagnostic-

Specimen (Specimen) resource Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

referenceRange 01 BackboneElement

Normal range of value associated with observation result (OBX7)

text 11 string Text based reference range in an observation

extension 01 Extension Nature of Abnormal Test (OBX10)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-nature-abnormal-test

valuecoding

11 coding Value set

extension 01 Extension Observation sub-id (OBX4)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation sort key (ZBX2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation comment (NTE-ZNT)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 22

url 11 uri httpehealthontariocaAPIfhir

StructureDefinitiondiagnosticReport-ext-observation-comment

valueAnnotation

11 annotation

authorString

11 string ZNT segment Indicate the organization (or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

434 Specimen Profile

ca-on-Diagnostic-Specimen profile based on httphl7orgfhirspecimenhtml

Name Card Type ValueVocab Description Comments

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

receivedTime 11 dateTime The time when specimen was received for processing

OBR14

request 1 Reference Contained ca-on-Diagnostic- ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

extension 11 Extension Organization that collected the specimen

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-specimen-collector-center

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Specimen Collector Center (ZBR3)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 23

Name Card Type ValueVocab Description Comments

Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

reference 11 string A reference to a location at which the other resource is found

reference 11 string A reference to a location at which the other resource is found

collected 01 Specimen collection time CollectedPeriod 11 Period

start 01 dateTime Starting specimen time OBR7 end 01 dateTime End specimen time OBR8

type 01 CodeableConcept

Kind of material that forms the specimen (Specimen Type)

OBR15

coding 01 coding Value Set from OLIS Code define by the terminology system

OBR1511

text 01 string Plain text representation of the concept

OBR1512

bodySite 01 CodeableConcept

Value Set Anatomical collection site OBR155

container 01 BackboneElement

Direct container of specimen

identifier 02 identifier Id for container OBR18 andor OBR20 Referring Lab User Specimen Identifier and Performing Lab User Specimen Identifier on Refereed ndashout orders

specimenQuantity

01 SimpleQuantity

Quantity of specimen within container

OBR37

note 01 Annotation Collectors comments text 11 string Collectors comments OBR39

extension 01 Extension Collection volume (OBR9)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-collection-volume

valueQuantity

11 Quantity

value 11 decimal Numeric value of the collection OBR91

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 24

volume unit 01 string Units of measure OBR921

435 Patient Profile

ca-on-Diagnostic-Patient profile based on httphl7orgfhirpatienthtml

Name

Card Type ValueVocab Description Comment

identifier

1 Identifier An identifier for this patient

system 11 uri [id-system-global-base]ca-on-patient-hcn

Patient Identifier Assigning Authority Namespace in which set of possible id values is unique (PID391 PID392 PID393)

Value 11 string Patient Identifier Number The portion of the identifier typically displayed to the user and which is unique within the context of the system (PID31)

extension 01 Health Card Version code (PID311) this is an extension patient identifier

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionext-identifier-hcn-version-code

valueString 11 string name

01 HumanName

use 11 code Value set httphl7orgfhirValueSetname-use

Purpose of this name Name type code PID57

Fix to the official for all cases except for anonymous For anonymous code should be lsquoanonymousrsquo

family 11 string Patient Last Name (PID51) given 02 string Patient First Name(PID52) extension 01 patient middle name (PID53)

this is an extension of given name

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode 11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name (PID55)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 25

Name

Card Type ValueVocab Description Comment

suffix 02 String Parts that come after the name (PID54)

extension 01 Patient degree designation This is an extension of suffix

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoACrdquo Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

telecom 03 Demographics Patient table Telephone Number system 01 code httphl7orgfhir

ValueSetcontact-point-system

Telecommunications form for contact point (Phone fax email pager url sms other) PID133 or PID143

Value 11 string The actual contact point details PID134-PID138 Or PID144-PID148

use 01 code httphl7orgfhirValueSetcontact-point-use

Use of contact point (Home work temp old mobile) PID132 or PID142

gender 11 code ldquomalerdquo ldquofemalerdquo ldquootherrdquo ldquounknownrdquo (httphl7orgfhirValueSetadministrative-gender)

The gender of a person used for administrative purposes (PID8)

birthDate 11 date The date of birth for the individual (PID7) Deceased[x]

01 boolean|dateTime

Indicates if the individual is deceased or not The value must be one of the choices specified below but not both System creating instance of this resource must decide which type to use at run time (PID30)

deceasedBoolean

boolean true|false

deceasedDateTime

dateTime Deceased datetime if known (PID29)

address 12 Address Demographics Patient table Address for the individual (PID11)

use 11 code ValueSet httphl7orgfhir

Address Type The use of an address

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 26

Name

Card Type ValueVocab Description Comment

ValueSetaddress-use

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

line 11 string Street lines (PID111) city 11 string Name of city town etc (PID113) state 01 string Province or territory (PID114) postalCode 01 string Postal code for area (PID115) country 11 string Country (can be ISO 3166 3 letter code) (PID116)

436 Practitioner Profile (Ordering Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent Ordering Practitioner information

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR1622

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR161

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR162 given 12 string Practitioner First Name OBR163

extension

01 Practitioner middle name this is an extension of given name

OBR164

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 21: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 18

url 11 httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-dateTime-transaction

valueDateTime 11 dateTime

requester 11 BackboneElement

agent 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource or Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the personorganization making request to perform the test (ordering practitionerorganization OBR16)

IF Ordering Facility exists in the message (ORC21) Scenario 1 requester (OBR16) is organization populate ORC21 with the same organization information that in OBR16 field Scenario 2 requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

onBehalfOf 01 reference Contained ca-on-Diagnostic-Organization (Organization) resource

A link to a resource representing the organization agent is acting for ordering facility

Should be mapped to ordering facility (ORC21 and ORC22) where requester OBR16 is practitioner ORC21 will contain organization information that requesting practitioner is associated with

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension CCrsquod list practitioner (OBR28) url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-cc-practitioner-list

valueReference (Practitioner)

110 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Practitioners named on an order (attending admitting ccrsquod)

reference 11 string A reference to a location at which the

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 19

other resource is found extension 01 Extension Test Request Placer ZBR2

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-test-request-placer

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Original Test Request Placer

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension Destination Laboratory ZBR8 url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-destination-laboratory

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Destination Laboratory

reference 11 string A reference to a location at which the other resource is found

note 05 Annotation comments authorString 11 string ZNT segment Indicate the organization

(or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

extension 11 Extension Source of Comment (NTE2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-source-comment

valueString

11 string

extension 11 Extension Set ID (NTE1)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 20

set-id

valueString

11 string

433 Observation Profile

ca-on-Diagnostic-Observation profile based on httphl7orgfhirobservationhtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Unique ID for the particular observation (OBR3)

system 11 uri The namespace for the identifier (OBR32) value 11 string The value that is unique (OBR31)

status 11 code Value set Observation result status (OBX11) code CodeableCo

ncept Value set LOINCSNOMED CT

Test result code (OBX3)

coding 11 coding Code defined by a terminology system (OBX31)

text 11 string Plain text representation of the concept (OBX32)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

effective 01 Clinically relevant time for observation

effectiveDateTime

01 dateTime DateTime of observation OBX141 Use this field for ancillary order only

This field must be empty when a laboratory reports a test result

issued 11 instant Indicate the date and time that the Test Result was released by the Reporting Laboratory (ZBX1)

performer (organization)

11 Reference Contained ca-on-Deagnostic-Organization (Organization) Resource or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

The individual responsible for performing the test Can be laboratory or practitioner

reference 11 string A reference to a location at which the other resource is found

value 11 Actual result

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 21

Name Card Type ValueVocab Description Comments

valueQuantity 11 Quantity (OBX2)-Only numeric test value value 11 decimal Numeric value of the test result (OBX5) unit 01 string When observation Value is a scalar value this

field describes the units of measure (OBX61)

interpretation 01 CodebaleConcept

Observation Interpretation Codes(OBX8)

coding 01 Coding Value set method 01 CodebaleCo

ncept How the observation has been done (OBX17)

text 11 string Plain text (OBX172) specimen 01 Reference Contained ca-on-Diagnostic-

Specimen (Specimen) resource Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

referenceRange 01 BackboneElement

Normal range of value associated with observation result (OBX7)

text 11 string Text based reference range in an observation

extension 01 Extension Nature of Abnormal Test (OBX10)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-nature-abnormal-test

valuecoding

11 coding Value set

extension 01 Extension Observation sub-id (OBX4)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation sort key (ZBX2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation comment (NTE-ZNT)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 22

url 11 uri httpehealthontariocaAPIfhir

StructureDefinitiondiagnosticReport-ext-observation-comment

valueAnnotation

11 annotation

authorString

11 string ZNT segment Indicate the organization (or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

434 Specimen Profile

ca-on-Diagnostic-Specimen profile based on httphl7orgfhirspecimenhtml

Name Card Type ValueVocab Description Comments

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

receivedTime 11 dateTime The time when specimen was received for processing

OBR14

request 1 Reference Contained ca-on-Diagnostic- ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

extension 11 Extension Organization that collected the specimen

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-specimen-collector-center

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Specimen Collector Center (ZBR3)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 23

Name Card Type ValueVocab Description Comments

Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

reference 11 string A reference to a location at which the other resource is found

reference 11 string A reference to a location at which the other resource is found

collected 01 Specimen collection time CollectedPeriod 11 Period

start 01 dateTime Starting specimen time OBR7 end 01 dateTime End specimen time OBR8

type 01 CodeableConcept

Kind of material that forms the specimen (Specimen Type)

OBR15

coding 01 coding Value Set from OLIS Code define by the terminology system

OBR1511

text 01 string Plain text representation of the concept

OBR1512

bodySite 01 CodeableConcept

Value Set Anatomical collection site OBR155

container 01 BackboneElement

Direct container of specimen

identifier 02 identifier Id for container OBR18 andor OBR20 Referring Lab User Specimen Identifier and Performing Lab User Specimen Identifier on Refereed ndashout orders

specimenQuantity

01 SimpleQuantity

Quantity of specimen within container

OBR37

note 01 Annotation Collectors comments text 11 string Collectors comments OBR39

extension 01 Extension Collection volume (OBR9)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-collection-volume

valueQuantity

11 Quantity

value 11 decimal Numeric value of the collection OBR91

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 24

volume unit 01 string Units of measure OBR921

435 Patient Profile

ca-on-Diagnostic-Patient profile based on httphl7orgfhirpatienthtml

Name

Card Type ValueVocab Description Comment

identifier

1 Identifier An identifier for this patient

system 11 uri [id-system-global-base]ca-on-patient-hcn

Patient Identifier Assigning Authority Namespace in which set of possible id values is unique (PID391 PID392 PID393)

Value 11 string Patient Identifier Number The portion of the identifier typically displayed to the user and which is unique within the context of the system (PID31)

extension 01 Health Card Version code (PID311) this is an extension patient identifier

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionext-identifier-hcn-version-code

valueString 11 string name

01 HumanName

use 11 code Value set httphl7orgfhirValueSetname-use

Purpose of this name Name type code PID57

Fix to the official for all cases except for anonymous For anonymous code should be lsquoanonymousrsquo

family 11 string Patient Last Name (PID51) given 02 string Patient First Name(PID52) extension 01 patient middle name (PID53)

this is an extension of given name

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode 11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name (PID55)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 25

Name

Card Type ValueVocab Description Comment

suffix 02 String Parts that come after the name (PID54)

extension 01 Patient degree designation This is an extension of suffix

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoACrdquo Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

telecom 03 Demographics Patient table Telephone Number system 01 code httphl7orgfhir

ValueSetcontact-point-system

Telecommunications form for contact point (Phone fax email pager url sms other) PID133 or PID143

Value 11 string The actual contact point details PID134-PID138 Or PID144-PID148

use 01 code httphl7orgfhirValueSetcontact-point-use

Use of contact point (Home work temp old mobile) PID132 or PID142

gender 11 code ldquomalerdquo ldquofemalerdquo ldquootherrdquo ldquounknownrdquo (httphl7orgfhirValueSetadministrative-gender)

The gender of a person used for administrative purposes (PID8)

birthDate 11 date The date of birth for the individual (PID7) Deceased[x]

01 boolean|dateTime

Indicates if the individual is deceased or not The value must be one of the choices specified below but not both System creating instance of this resource must decide which type to use at run time (PID30)

deceasedBoolean

boolean true|false

deceasedDateTime

dateTime Deceased datetime if known (PID29)

address 12 Address Demographics Patient table Address for the individual (PID11)

use 11 code ValueSet httphl7orgfhir

Address Type The use of an address

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 26

Name

Card Type ValueVocab Description Comment

ValueSetaddress-use

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

line 11 string Street lines (PID111) city 11 string Name of city town etc (PID113) state 01 string Province or territory (PID114) postalCode 01 string Postal code for area (PID115) country 11 string Country (can be ISO 3166 3 letter code) (PID116)

436 Practitioner Profile (Ordering Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent Ordering Practitioner information

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR1622

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR161

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR162 given 12 string Practitioner First Name OBR163

extension

01 Practitioner middle name this is an extension of given name

OBR164

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 22: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 19

other resource is found extension 01 Extension Test Request Placer ZBR2

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-test-request-placer

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

Original Test Request Placer

reference 11 string A reference to a location at which the other resource is found

extension 01 Extension Destination Laboratory ZBR8 url 11 uri Fixed

httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-destination-laboratory

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Destination Laboratory

reference 11 string A reference to a location at which the other resource is found

note 05 Annotation comments authorString 11 string ZNT segment Indicate the organization

(or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

extension 11 Extension Source of Comment (NTE2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-source-comment

valueString

11 string

extension 11 Extension Set ID (NTE1)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionprocedureRequest-ext-

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 20

set-id

valueString

11 string

433 Observation Profile

ca-on-Diagnostic-Observation profile based on httphl7orgfhirobservationhtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Unique ID for the particular observation (OBR3)

system 11 uri The namespace for the identifier (OBR32) value 11 string The value that is unique (OBR31)

status 11 code Value set Observation result status (OBX11) code CodeableCo

ncept Value set LOINCSNOMED CT

Test result code (OBX3)

coding 11 coding Code defined by a terminology system (OBX31)

text 11 string Plain text representation of the concept (OBX32)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

effective 01 Clinically relevant time for observation

effectiveDateTime

01 dateTime DateTime of observation OBX141 Use this field for ancillary order only

This field must be empty when a laboratory reports a test result

issued 11 instant Indicate the date and time that the Test Result was released by the Reporting Laboratory (ZBX1)

performer (organization)

11 Reference Contained ca-on-Deagnostic-Organization (Organization) Resource or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

The individual responsible for performing the test Can be laboratory or practitioner

reference 11 string A reference to a location at which the other resource is found

value 11 Actual result

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 21

Name Card Type ValueVocab Description Comments

valueQuantity 11 Quantity (OBX2)-Only numeric test value value 11 decimal Numeric value of the test result (OBX5) unit 01 string When observation Value is a scalar value this

field describes the units of measure (OBX61)

interpretation 01 CodebaleConcept

Observation Interpretation Codes(OBX8)

coding 01 Coding Value set method 01 CodebaleCo

ncept How the observation has been done (OBX17)

text 11 string Plain text (OBX172) specimen 01 Reference Contained ca-on-Diagnostic-

Specimen (Specimen) resource Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

referenceRange 01 BackboneElement

Normal range of value associated with observation result (OBX7)

text 11 string Text based reference range in an observation

extension 01 Extension Nature of Abnormal Test (OBX10)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-nature-abnormal-test

valuecoding

11 coding Value set

extension 01 Extension Observation sub-id (OBX4)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation sort key (ZBX2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation comment (NTE-ZNT)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 22

url 11 uri httpehealthontariocaAPIfhir

StructureDefinitiondiagnosticReport-ext-observation-comment

valueAnnotation

11 annotation

authorString

11 string ZNT segment Indicate the organization (or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

434 Specimen Profile

ca-on-Diagnostic-Specimen profile based on httphl7orgfhirspecimenhtml

Name Card Type ValueVocab Description Comments

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

receivedTime 11 dateTime The time when specimen was received for processing

OBR14

request 1 Reference Contained ca-on-Diagnostic- ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

extension 11 Extension Organization that collected the specimen

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-specimen-collector-center

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Specimen Collector Center (ZBR3)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 23

Name Card Type ValueVocab Description Comments

Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

reference 11 string A reference to a location at which the other resource is found

reference 11 string A reference to a location at which the other resource is found

collected 01 Specimen collection time CollectedPeriod 11 Period

start 01 dateTime Starting specimen time OBR7 end 01 dateTime End specimen time OBR8

type 01 CodeableConcept

Kind of material that forms the specimen (Specimen Type)

OBR15

coding 01 coding Value Set from OLIS Code define by the terminology system

OBR1511

text 01 string Plain text representation of the concept

OBR1512

bodySite 01 CodeableConcept

Value Set Anatomical collection site OBR155

container 01 BackboneElement

Direct container of specimen

identifier 02 identifier Id for container OBR18 andor OBR20 Referring Lab User Specimen Identifier and Performing Lab User Specimen Identifier on Refereed ndashout orders

specimenQuantity

01 SimpleQuantity

Quantity of specimen within container

OBR37

note 01 Annotation Collectors comments text 11 string Collectors comments OBR39

extension 01 Extension Collection volume (OBR9)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-collection-volume

valueQuantity

11 Quantity

value 11 decimal Numeric value of the collection OBR91

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 24

volume unit 01 string Units of measure OBR921

435 Patient Profile

ca-on-Diagnostic-Patient profile based on httphl7orgfhirpatienthtml

Name

Card Type ValueVocab Description Comment

identifier

1 Identifier An identifier for this patient

system 11 uri [id-system-global-base]ca-on-patient-hcn

Patient Identifier Assigning Authority Namespace in which set of possible id values is unique (PID391 PID392 PID393)

Value 11 string Patient Identifier Number The portion of the identifier typically displayed to the user and which is unique within the context of the system (PID31)

extension 01 Health Card Version code (PID311) this is an extension patient identifier

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionext-identifier-hcn-version-code

valueString 11 string name

01 HumanName

use 11 code Value set httphl7orgfhirValueSetname-use

Purpose of this name Name type code PID57

Fix to the official for all cases except for anonymous For anonymous code should be lsquoanonymousrsquo

family 11 string Patient Last Name (PID51) given 02 string Patient First Name(PID52) extension 01 patient middle name (PID53)

this is an extension of given name

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode 11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name (PID55)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 25

Name

Card Type ValueVocab Description Comment

suffix 02 String Parts that come after the name (PID54)

extension 01 Patient degree designation This is an extension of suffix

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoACrdquo Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

telecom 03 Demographics Patient table Telephone Number system 01 code httphl7orgfhir

ValueSetcontact-point-system

Telecommunications form for contact point (Phone fax email pager url sms other) PID133 or PID143

Value 11 string The actual contact point details PID134-PID138 Or PID144-PID148

use 01 code httphl7orgfhirValueSetcontact-point-use

Use of contact point (Home work temp old mobile) PID132 or PID142

gender 11 code ldquomalerdquo ldquofemalerdquo ldquootherrdquo ldquounknownrdquo (httphl7orgfhirValueSetadministrative-gender)

The gender of a person used for administrative purposes (PID8)

birthDate 11 date The date of birth for the individual (PID7) Deceased[x]

01 boolean|dateTime

Indicates if the individual is deceased or not The value must be one of the choices specified below but not both System creating instance of this resource must decide which type to use at run time (PID30)

deceasedBoolean

boolean true|false

deceasedDateTime

dateTime Deceased datetime if known (PID29)

address 12 Address Demographics Patient table Address for the individual (PID11)

use 11 code ValueSet httphl7orgfhir

Address Type The use of an address

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 26

Name

Card Type ValueVocab Description Comment

ValueSetaddress-use

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

line 11 string Street lines (PID111) city 11 string Name of city town etc (PID113) state 01 string Province or territory (PID114) postalCode 01 string Postal code for area (PID115) country 11 string Country (can be ISO 3166 3 letter code) (PID116)

436 Practitioner Profile (Ordering Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent Ordering Practitioner information

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR1622

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR161

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR162 given 12 string Practitioner First Name OBR163

extension

01 Practitioner middle name this is an extension of given name

OBR164

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 23: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 20

set-id

valueString

11 string

433 Observation Profile

ca-on-Diagnostic-Observation profile based on httphl7orgfhirobservationhtml

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Unique ID for the particular observation (OBR3)

system 11 uri The namespace for the identifier (OBR32) value 11 string The value that is unique (OBR31)

status 11 code Value set Observation result status (OBX11) code CodeableCo

ncept Value set LOINCSNOMED CT

Test result code (OBX3)

coding 11 coding Code defined by a terminology system (OBX31)

text 11 string Plain text representation of the concept (OBX32)

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

effective 01 Clinically relevant time for observation

effectiveDateTime

01 dateTime DateTime of observation OBX141 Use this field for ancillary order only

This field must be empty when a laboratory reports a test result

issued 11 instant Indicate the date and time that the Test Result was released by the Reporting Laboratory (ZBX1)

performer (organization)

11 Reference Contained ca-on-Deagnostic-Organization (Organization) Resource or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

The individual responsible for performing the test Can be laboratory or practitioner

reference 11 string A reference to a location at which the other resource is found

value 11 Actual result

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 21

Name Card Type ValueVocab Description Comments

valueQuantity 11 Quantity (OBX2)-Only numeric test value value 11 decimal Numeric value of the test result (OBX5) unit 01 string When observation Value is a scalar value this

field describes the units of measure (OBX61)

interpretation 01 CodebaleConcept

Observation Interpretation Codes(OBX8)

coding 01 Coding Value set method 01 CodebaleCo

ncept How the observation has been done (OBX17)

text 11 string Plain text (OBX172) specimen 01 Reference Contained ca-on-Diagnostic-

Specimen (Specimen) resource Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

referenceRange 01 BackboneElement

Normal range of value associated with observation result (OBX7)

text 11 string Text based reference range in an observation

extension 01 Extension Nature of Abnormal Test (OBX10)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-nature-abnormal-test

valuecoding

11 coding Value set

extension 01 Extension Observation sub-id (OBX4)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation sort key (ZBX2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation comment (NTE-ZNT)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 22

url 11 uri httpehealthontariocaAPIfhir

StructureDefinitiondiagnosticReport-ext-observation-comment

valueAnnotation

11 annotation

authorString

11 string ZNT segment Indicate the organization (or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

434 Specimen Profile

ca-on-Diagnostic-Specimen profile based on httphl7orgfhirspecimenhtml

Name Card Type ValueVocab Description Comments

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

receivedTime 11 dateTime The time when specimen was received for processing

OBR14

request 1 Reference Contained ca-on-Diagnostic- ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

extension 11 Extension Organization that collected the specimen

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-specimen-collector-center

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Specimen Collector Center (ZBR3)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 23

Name Card Type ValueVocab Description Comments

Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

reference 11 string A reference to a location at which the other resource is found

reference 11 string A reference to a location at which the other resource is found

collected 01 Specimen collection time CollectedPeriod 11 Period

start 01 dateTime Starting specimen time OBR7 end 01 dateTime End specimen time OBR8

type 01 CodeableConcept

Kind of material that forms the specimen (Specimen Type)

OBR15

coding 01 coding Value Set from OLIS Code define by the terminology system

OBR1511

text 01 string Plain text representation of the concept

OBR1512

bodySite 01 CodeableConcept

Value Set Anatomical collection site OBR155

container 01 BackboneElement

Direct container of specimen

identifier 02 identifier Id for container OBR18 andor OBR20 Referring Lab User Specimen Identifier and Performing Lab User Specimen Identifier on Refereed ndashout orders

specimenQuantity

01 SimpleQuantity

Quantity of specimen within container

OBR37

note 01 Annotation Collectors comments text 11 string Collectors comments OBR39

extension 01 Extension Collection volume (OBR9)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-collection-volume

valueQuantity

11 Quantity

value 11 decimal Numeric value of the collection OBR91

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 24

volume unit 01 string Units of measure OBR921

435 Patient Profile

ca-on-Diagnostic-Patient profile based on httphl7orgfhirpatienthtml

Name

Card Type ValueVocab Description Comment

identifier

1 Identifier An identifier for this patient

system 11 uri [id-system-global-base]ca-on-patient-hcn

Patient Identifier Assigning Authority Namespace in which set of possible id values is unique (PID391 PID392 PID393)

Value 11 string Patient Identifier Number The portion of the identifier typically displayed to the user and which is unique within the context of the system (PID31)

extension 01 Health Card Version code (PID311) this is an extension patient identifier

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionext-identifier-hcn-version-code

valueString 11 string name

01 HumanName

use 11 code Value set httphl7orgfhirValueSetname-use

Purpose of this name Name type code PID57

Fix to the official for all cases except for anonymous For anonymous code should be lsquoanonymousrsquo

family 11 string Patient Last Name (PID51) given 02 string Patient First Name(PID52) extension 01 patient middle name (PID53)

this is an extension of given name

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode 11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name (PID55)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 25

Name

Card Type ValueVocab Description Comment

suffix 02 String Parts that come after the name (PID54)

extension 01 Patient degree designation This is an extension of suffix

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoACrdquo Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

telecom 03 Demographics Patient table Telephone Number system 01 code httphl7orgfhir

ValueSetcontact-point-system

Telecommunications form for contact point (Phone fax email pager url sms other) PID133 or PID143

Value 11 string The actual contact point details PID134-PID138 Or PID144-PID148

use 01 code httphl7orgfhirValueSetcontact-point-use

Use of contact point (Home work temp old mobile) PID132 or PID142

gender 11 code ldquomalerdquo ldquofemalerdquo ldquootherrdquo ldquounknownrdquo (httphl7orgfhirValueSetadministrative-gender)

The gender of a person used for administrative purposes (PID8)

birthDate 11 date The date of birth for the individual (PID7) Deceased[x]

01 boolean|dateTime

Indicates if the individual is deceased or not The value must be one of the choices specified below but not both System creating instance of this resource must decide which type to use at run time (PID30)

deceasedBoolean

boolean true|false

deceasedDateTime

dateTime Deceased datetime if known (PID29)

address 12 Address Demographics Patient table Address for the individual (PID11)

use 11 code ValueSet httphl7orgfhir

Address Type The use of an address

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 26

Name

Card Type ValueVocab Description Comment

ValueSetaddress-use

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

line 11 string Street lines (PID111) city 11 string Name of city town etc (PID113) state 01 string Province or territory (PID114) postalCode 01 string Postal code for area (PID115) country 11 string Country (can be ISO 3166 3 letter code) (PID116)

436 Practitioner Profile (Ordering Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent Ordering Practitioner information

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR1622

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR161

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR162 given 12 string Practitioner First Name OBR163

extension

01 Practitioner middle name this is an extension of given name

OBR164

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 24: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 21

Name Card Type ValueVocab Description Comments

valueQuantity 11 Quantity (OBX2)-Only numeric test value value 11 decimal Numeric value of the test result (OBX5) unit 01 string When observation Value is a scalar value this

field describes the units of measure (OBX61)

interpretation 01 CodebaleConcept

Observation Interpretation Codes(OBX8)

coding 01 Coding Value set method 01 CodebaleCo

ncept How the observation has been done (OBX17)

text 11 string Plain text (OBX172) specimen 01 Reference Contained ca-on-Diagnostic-

Specimen (Specimen) resource Specimens this report is based on

reference 11 string A reference to a location at which the other resource is found

referenceRange 01 BackboneElement

Normal range of value associated with observation result (OBX7)

text 11 string Text based reference range in an observation

extension 01 Extension Nature of Abnormal Test (OBX10)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-nature-abnormal-test

valuecoding

11 coding Value set

extension 01 Extension Observation sub-id (OBX4)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation sort key (ZBX2)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-observation-sub-id

valueString

11 string

extension 01 Extension Observation comment (NTE-ZNT)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 22

url 11 uri httpehealthontariocaAPIfhir

StructureDefinitiondiagnosticReport-ext-observation-comment

valueAnnotation

11 annotation

authorString

11 string ZNT segment Indicate the organization (or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

434 Specimen Profile

ca-on-Diagnostic-Specimen profile based on httphl7orgfhirspecimenhtml

Name Card Type ValueVocab Description Comments

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

receivedTime 11 dateTime The time when specimen was received for processing

OBR14

request 1 Reference Contained ca-on-Diagnostic- ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

extension 11 Extension Organization that collected the specimen

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-specimen-collector-center

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Specimen Collector Center (ZBR3)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 23

Name Card Type ValueVocab Description Comments

Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

reference 11 string A reference to a location at which the other resource is found

reference 11 string A reference to a location at which the other resource is found

collected 01 Specimen collection time CollectedPeriod 11 Period

start 01 dateTime Starting specimen time OBR7 end 01 dateTime End specimen time OBR8

type 01 CodeableConcept

Kind of material that forms the specimen (Specimen Type)

OBR15

coding 01 coding Value Set from OLIS Code define by the terminology system

OBR1511

text 01 string Plain text representation of the concept

OBR1512

bodySite 01 CodeableConcept

Value Set Anatomical collection site OBR155

container 01 BackboneElement

Direct container of specimen

identifier 02 identifier Id for container OBR18 andor OBR20 Referring Lab User Specimen Identifier and Performing Lab User Specimen Identifier on Refereed ndashout orders

specimenQuantity

01 SimpleQuantity

Quantity of specimen within container

OBR37

note 01 Annotation Collectors comments text 11 string Collectors comments OBR39

extension 01 Extension Collection volume (OBR9)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-collection-volume

valueQuantity

11 Quantity

value 11 decimal Numeric value of the collection OBR91

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 24

volume unit 01 string Units of measure OBR921

435 Patient Profile

ca-on-Diagnostic-Patient profile based on httphl7orgfhirpatienthtml

Name

Card Type ValueVocab Description Comment

identifier

1 Identifier An identifier for this patient

system 11 uri [id-system-global-base]ca-on-patient-hcn

Patient Identifier Assigning Authority Namespace in which set of possible id values is unique (PID391 PID392 PID393)

Value 11 string Patient Identifier Number The portion of the identifier typically displayed to the user and which is unique within the context of the system (PID31)

extension 01 Health Card Version code (PID311) this is an extension patient identifier

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionext-identifier-hcn-version-code

valueString 11 string name

01 HumanName

use 11 code Value set httphl7orgfhirValueSetname-use

Purpose of this name Name type code PID57

Fix to the official for all cases except for anonymous For anonymous code should be lsquoanonymousrsquo

family 11 string Patient Last Name (PID51) given 02 string Patient First Name(PID52) extension 01 patient middle name (PID53)

this is an extension of given name

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode 11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name (PID55)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 25

Name

Card Type ValueVocab Description Comment

suffix 02 String Parts that come after the name (PID54)

extension 01 Patient degree designation This is an extension of suffix

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoACrdquo Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

telecom 03 Demographics Patient table Telephone Number system 01 code httphl7orgfhir

ValueSetcontact-point-system

Telecommunications form for contact point (Phone fax email pager url sms other) PID133 or PID143

Value 11 string The actual contact point details PID134-PID138 Or PID144-PID148

use 01 code httphl7orgfhirValueSetcontact-point-use

Use of contact point (Home work temp old mobile) PID132 or PID142

gender 11 code ldquomalerdquo ldquofemalerdquo ldquootherrdquo ldquounknownrdquo (httphl7orgfhirValueSetadministrative-gender)

The gender of a person used for administrative purposes (PID8)

birthDate 11 date The date of birth for the individual (PID7) Deceased[x]

01 boolean|dateTime

Indicates if the individual is deceased or not The value must be one of the choices specified below but not both System creating instance of this resource must decide which type to use at run time (PID30)

deceasedBoolean

boolean true|false

deceasedDateTime

dateTime Deceased datetime if known (PID29)

address 12 Address Demographics Patient table Address for the individual (PID11)

use 11 code ValueSet httphl7orgfhir

Address Type The use of an address

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 26

Name

Card Type ValueVocab Description Comment

ValueSetaddress-use

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

line 11 string Street lines (PID111) city 11 string Name of city town etc (PID113) state 01 string Province or territory (PID114) postalCode 01 string Postal code for area (PID115) country 11 string Country (can be ISO 3166 3 letter code) (PID116)

436 Practitioner Profile (Ordering Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent Ordering Practitioner information

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR1622

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR161

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR162 given 12 string Practitioner First Name OBR163

extension

01 Practitioner middle name this is an extension of given name

OBR164

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 25: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 22

url 11 uri httpehealthontariocaAPIfhir

StructureDefinitiondiagnosticReport-ext-observation-comment

valueAnnotation

11 annotation

authorString

11 string ZNT segment Indicate the organization (or system in the absence of an organization) that contributed the note to the order

text 11 string comment (NTE segment)

434 Specimen Profile

ca-on-Diagnostic-Specimen profile based on httphl7orgfhirspecimenhtml

Name Card Type ValueVocab Description Comments

Subject (patient) 11 Reference Contained ca-on-Diagnostic-Patient (Patient) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

receivedTime 11 dateTime The time when specimen was received for processing

OBR14

request 1 Reference Contained ca-on-Diagnostic- ProcedureRequest (ProcedureRequest) resource

Indicates the test that has been requested

reference 11 string A reference to a location at which the other resource is found

extension 11 Extension Organization that collected the specimen

url 11 uri Fixed httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-specimen-collector-center

valueReference (Organization)

11 reference Contained ca-on-Diagnostic-Organization (Organization) resource

Specimen Collector Center (ZBR3)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 23

Name Card Type ValueVocab Description Comments

Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

reference 11 string A reference to a location at which the other resource is found

reference 11 string A reference to a location at which the other resource is found

collected 01 Specimen collection time CollectedPeriod 11 Period

start 01 dateTime Starting specimen time OBR7 end 01 dateTime End specimen time OBR8

type 01 CodeableConcept

Kind of material that forms the specimen (Specimen Type)

OBR15

coding 01 coding Value Set from OLIS Code define by the terminology system

OBR1511

text 01 string Plain text representation of the concept

OBR1512

bodySite 01 CodeableConcept

Value Set Anatomical collection site OBR155

container 01 BackboneElement

Direct container of specimen

identifier 02 identifier Id for container OBR18 andor OBR20 Referring Lab User Specimen Identifier and Performing Lab User Specimen Identifier on Refereed ndashout orders

specimenQuantity

01 SimpleQuantity

Quantity of specimen within container

OBR37

note 01 Annotation Collectors comments text 11 string Collectors comments OBR39

extension 01 Extension Collection volume (OBR9)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-collection-volume

valueQuantity

11 Quantity

value 11 decimal Numeric value of the collection OBR91

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 24

volume unit 01 string Units of measure OBR921

435 Patient Profile

ca-on-Diagnostic-Patient profile based on httphl7orgfhirpatienthtml

Name

Card Type ValueVocab Description Comment

identifier

1 Identifier An identifier for this patient

system 11 uri [id-system-global-base]ca-on-patient-hcn

Patient Identifier Assigning Authority Namespace in which set of possible id values is unique (PID391 PID392 PID393)

Value 11 string Patient Identifier Number The portion of the identifier typically displayed to the user and which is unique within the context of the system (PID31)

extension 01 Health Card Version code (PID311) this is an extension patient identifier

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionext-identifier-hcn-version-code

valueString 11 string name

01 HumanName

use 11 code Value set httphl7orgfhirValueSetname-use

Purpose of this name Name type code PID57

Fix to the official for all cases except for anonymous For anonymous code should be lsquoanonymousrsquo

family 11 string Patient Last Name (PID51) given 02 string Patient First Name(PID52) extension 01 patient middle name (PID53)

this is an extension of given name

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode 11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name (PID55)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 25

Name

Card Type ValueVocab Description Comment

suffix 02 String Parts that come after the name (PID54)

extension 01 Patient degree designation This is an extension of suffix

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoACrdquo Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

telecom 03 Demographics Patient table Telephone Number system 01 code httphl7orgfhir

ValueSetcontact-point-system

Telecommunications form for contact point (Phone fax email pager url sms other) PID133 or PID143

Value 11 string The actual contact point details PID134-PID138 Or PID144-PID148

use 01 code httphl7orgfhirValueSetcontact-point-use

Use of contact point (Home work temp old mobile) PID132 or PID142

gender 11 code ldquomalerdquo ldquofemalerdquo ldquootherrdquo ldquounknownrdquo (httphl7orgfhirValueSetadministrative-gender)

The gender of a person used for administrative purposes (PID8)

birthDate 11 date The date of birth for the individual (PID7) Deceased[x]

01 boolean|dateTime

Indicates if the individual is deceased or not The value must be one of the choices specified below but not both System creating instance of this resource must decide which type to use at run time (PID30)

deceasedBoolean

boolean true|false

deceasedDateTime

dateTime Deceased datetime if known (PID29)

address 12 Address Demographics Patient table Address for the individual (PID11)

use 11 code ValueSet httphl7orgfhir

Address Type The use of an address

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 26

Name

Card Type ValueVocab Description Comment

ValueSetaddress-use

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

line 11 string Street lines (PID111) city 11 string Name of city town etc (PID113) state 01 string Province or territory (PID114) postalCode 01 string Postal code for area (PID115) country 11 string Country (can be ISO 3166 3 letter code) (PID116)

436 Practitioner Profile (Ordering Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent Ordering Practitioner information

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR1622

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR161

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR162 given 12 string Practitioner First Name OBR163

extension

01 Practitioner middle name this is an extension of given name

OBR164

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 26: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 23

Name Card Type ValueVocab Description Comments

Or Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

reference 11 string A reference to a location at which the other resource is found

reference 11 string A reference to a location at which the other resource is found

collected 01 Specimen collection time CollectedPeriod 11 Period

start 01 dateTime Starting specimen time OBR7 end 01 dateTime End specimen time OBR8

type 01 CodeableConcept

Kind of material that forms the specimen (Specimen Type)

OBR15

coding 01 coding Value Set from OLIS Code define by the terminology system

OBR1511

text 01 string Plain text representation of the concept

OBR1512

bodySite 01 CodeableConcept

Value Set Anatomical collection site OBR155

container 01 BackboneElement

Direct container of specimen

identifier 02 identifier Id for container OBR18 andor OBR20 Referring Lab User Specimen Identifier and Performing Lab User Specimen Identifier on Refereed ndashout orders

specimenQuantity

01 SimpleQuantity

Quantity of specimen within container

OBR37

note 01 Annotation Collectors comments text 11 string Collectors comments OBR39

extension 01 Extension Collection volume (OBR9)

url 11 uri httpehealthontariocaAPIfhirStructureDefinitiondiagnosticReport-ext-collection-volume

valueQuantity

11 Quantity

value 11 decimal Numeric value of the collection OBR91

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 24

volume unit 01 string Units of measure OBR921

435 Patient Profile

ca-on-Diagnostic-Patient profile based on httphl7orgfhirpatienthtml

Name

Card Type ValueVocab Description Comment

identifier

1 Identifier An identifier for this patient

system 11 uri [id-system-global-base]ca-on-patient-hcn

Patient Identifier Assigning Authority Namespace in which set of possible id values is unique (PID391 PID392 PID393)

Value 11 string Patient Identifier Number The portion of the identifier typically displayed to the user and which is unique within the context of the system (PID31)

extension 01 Health Card Version code (PID311) this is an extension patient identifier

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionext-identifier-hcn-version-code

valueString 11 string name

01 HumanName

use 11 code Value set httphl7orgfhirValueSetname-use

Purpose of this name Name type code PID57

Fix to the official for all cases except for anonymous For anonymous code should be lsquoanonymousrsquo

family 11 string Patient Last Name (PID51) given 02 string Patient First Name(PID52) extension 01 patient middle name (PID53)

this is an extension of given name

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode 11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name (PID55)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 25

Name

Card Type ValueVocab Description Comment

suffix 02 String Parts that come after the name (PID54)

extension 01 Patient degree designation This is an extension of suffix

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoACrdquo Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

telecom 03 Demographics Patient table Telephone Number system 01 code httphl7orgfhir

ValueSetcontact-point-system

Telecommunications form for contact point (Phone fax email pager url sms other) PID133 or PID143

Value 11 string The actual contact point details PID134-PID138 Or PID144-PID148

use 01 code httphl7orgfhirValueSetcontact-point-use

Use of contact point (Home work temp old mobile) PID132 or PID142

gender 11 code ldquomalerdquo ldquofemalerdquo ldquootherrdquo ldquounknownrdquo (httphl7orgfhirValueSetadministrative-gender)

The gender of a person used for administrative purposes (PID8)

birthDate 11 date The date of birth for the individual (PID7) Deceased[x]

01 boolean|dateTime

Indicates if the individual is deceased or not The value must be one of the choices specified below but not both System creating instance of this resource must decide which type to use at run time (PID30)

deceasedBoolean

boolean true|false

deceasedDateTime

dateTime Deceased datetime if known (PID29)

address 12 Address Demographics Patient table Address for the individual (PID11)

use 11 code ValueSet httphl7orgfhir

Address Type The use of an address

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 26

Name

Card Type ValueVocab Description Comment

ValueSetaddress-use

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

line 11 string Street lines (PID111) city 11 string Name of city town etc (PID113) state 01 string Province or territory (PID114) postalCode 01 string Postal code for area (PID115) country 11 string Country (can be ISO 3166 3 letter code) (PID116)

436 Practitioner Profile (Ordering Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent Ordering Practitioner information

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR1622

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR161

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR162 given 12 string Practitioner First Name OBR163

extension

01 Practitioner middle name this is an extension of given name

OBR164

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 27: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 24

volume unit 01 string Units of measure OBR921

435 Patient Profile

ca-on-Diagnostic-Patient profile based on httphl7orgfhirpatienthtml

Name

Card Type ValueVocab Description Comment

identifier

1 Identifier An identifier for this patient

system 11 uri [id-system-global-base]ca-on-patient-hcn

Patient Identifier Assigning Authority Namespace in which set of possible id values is unique (PID391 PID392 PID393)

Value 11 string Patient Identifier Number The portion of the identifier typically displayed to the user and which is unique within the context of the system (PID31)

extension 01 Health Card Version code (PID311) this is an extension patient identifier

url 11 uri httpehealthontariocaAPIfhirStructureDefinitionext-identifier-hcn-version-code

valueString 11 string name

01 HumanName

use 11 code Value set httphl7orgfhirValueSetname-use

Purpose of this name Name type code PID57

Fix to the official for all cases except for anonymous For anonymous code should be lsquoanonymousrsquo

family 11 string Patient Last Name (PID51) given 02 string Patient First Name(PID52) extension 01 patient middle name (PID53)

this is an extension of given name

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode 11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name (PID55)

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 25

Name

Card Type ValueVocab Description Comment

suffix 02 String Parts that come after the name (PID54)

extension 01 Patient degree designation This is an extension of suffix

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoACrdquo Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

telecom 03 Demographics Patient table Telephone Number system 01 code httphl7orgfhir

ValueSetcontact-point-system

Telecommunications form for contact point (Phone fax email pager url sms other) PID133 or PID143

Value 11 string The actual contact point details PID134-PID138 Or PID144-PID148

use 01 code httphl7orgfhirValueSetcontact-point-use

Use of contact point (Home work temp old mobile) PID132 or PID142

gender 11 code ldquomalerdquo ldquofemalerdquo ldquootherrdquo ldquounknownrdquo (httphl7orgfhirValueSetadministrative-gender)

The gender of a person used for administrative purposes (PID8)

birthDate 11 date The date of birth for the individual (PID7) Deceased[x]

01 boolean|dateTime

Indicates if the individual is deceased or not The value must be one of the choices specified below but not both System creating instance of this resource must decide which type to use at run time (PID30)

deceasedBoolean

boolean true|false

deceasedDateTime

dateTime Deceased datetime if known (PID29)

address 12 Address Demographics Patient table Address for the individual (PID11)

use 11 code ValueSet httphl7orgfhir

Address Type The use of an address

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 26

Name

Card Type ValueVocab Description Comment

ValueSetaddress-use

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

line 11 string Street lines (PID111) city 11 string Name of city town etc (PID113) state 01 string Province or territory (PID114) postalCode 01 string Postal code for area (PID115) country 11 string Country (can be ISO 3166 3 letter code) (PID116)

436 Practitioner Profile (Ordering Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent Ordering Practitioner information

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR1622

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR161

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR162 given 12 string Practitioner First Name OBR163

extension

01 Practitioner middle name this is an extension of given name

OBR164

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 28: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 25

Name

Card Type ValueVocab Description Comment

suffix 02 String Parts that come after the name (PID54)

extension 01 Patient degree designation This is an extension of suffix

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoACrdquo Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

telecom 03 Demographics Patient table Telephone Number system 01 code httphl7orgfhir

ValueSetcontact-point-system

Telecommunications form for contact point (Phone fax email pager url sms other) PID133 or PID143

Value 11 string The actual contact point details PID134-PID138 Or PID144-PID148

use 01 code httphl7orgfhirValueSetcontact-point-use

Use of contact point (Home work temp old mobile) PID132 or PID142

gender 11 code ldquomalerdquo ldquofemalerdquo ldquootherrdquo ldquounknownrdquo (httphl7orgfhirValueSetadministrative-gender)

The gender of a person used for administrative purposes (PID8)

birthDate 11 date The date of birth for the individual (PID7) Deceased[x]

01 boolean|dateTime

Indicates if the individual is deceased or not The value must be one of the choices specified below but not both System creating instance of this resource must decide which type to use at run time (PID30)

deceasedBoolean

boolean true|false

deceasedDateTime

dateTime Deceased datetime if known (PID29)

address 12 Address Demographics Patient table Address for the individual (PID11)

use 11 code ValueSet httphl7orgfhir

Address Type The use of an address

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 26

Name

Card Type ValueVocab Description Comment

ValueSetaddress-use

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

line 11 string Street lines (PID111) city 11 string Name of city town etc (PID113) state 01 string Province or territory (PID114) postalCode 01 string Postal code for area (PID115) country 11 string Country (can be ISO 3166 3 letter code) (PID116)

436 Practitioner Profile (Ordering Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent Ordering Practitioner information

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR1622

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR161

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR162 given 12 string Practitioner First Name OBR163

extension

01 Practitioner middle name this is an extension of given name

OBR164

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 29: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 26

Name

Card Type ValueVocab Description Comment

ValueSetaddress-use

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

line 11 string Street lines (PID111) city 11 string Name of city town etc (PID113) state 01 string Province or territory (PID114) postalCode 01 string Postal code for area (PID115) country 11 string Country (can be ISO 3166 3 letter code) (PID116)

436 Practitioner Profile (Ordering Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent Ordering Practitioner information

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR1622

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR161

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR162 given 12 string Practitioner First Name OBR163

extension

01 Practitioner middle name this is an extension of given name

OBR164

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 30: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 27

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR166

suffix 01 string Parts that come after the name

OBR165

telecom 02 ContactPoint

Practitioner Phone Number OBR17

system 01 code ValueSet httphl7orgfhirValueSetcontact-point-system

Telecommunications form for contact point

OBR173

value 01 string The actual contact point details OBR175-OBR178 use 01 code ValueSet

httphl7orgfhirValueSetcontact-point-use

Use of contact point OBR172

address 01 Address Ordering Practitioner Address

OBR17

use 11 code ValueSet httphl7orgfhirValueSetaddress-use

Address Type The use of an address

type 11 code ValueSet httphl7orgfhirValueSetaddress-type

Address Type The type of an address (physical postal)

ORC247

line 11 string Street lines ORC241 city 11 string Name of city town etc ORC243 state 01 string Province or territory ORC244 postalCode 01 string Postal code for area ORC245 country 11 string Country (can be ISO 3166 3 letter

code)

ORC246

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR163

437 Practitioner Profile (CC List Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent extension for ccrsquod list physicians

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 31: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 28

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) OBR2822

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner OBR281

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name OBR282 given 12 string Practitioner First Name OBR283

extension

01 Practitioner middle name this is an extension of given name

OBR284

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Value set httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

OBR286

suffix 01 string Parts that come after the name

OBR285

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

OBR2813

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 32: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 29

438 Practitioner Profile (Attending Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent attending physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV1722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV172 given 12 string Practitioner First Name PV173

extension

01 Practitioner middle name this is an extension of given name

PV174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV176

suffix 01 string Parts that come after the name

PV175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV1713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 33: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 30

439 Practitioner Profile (Admitting Practitioner)

ca-on-Diagnostic-Practitioner profile based on httphl7orgfhirpractitionerhtml

This resource will represent admitting physicians which is reference from Encounter resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Practitioner ID (Licence) Practitioner Dentist Nurse Practitioner Midwife

system 11 uri URI of a licence regulating body

Namespace in which set of possible id values is unique

Eg [id-system-global-base]ca-on-license-physician Need to add Terminology Worksheet for list of URIs (should be colleges URIs) PV11722

value 11 string Licence The portion of the identifier typically displayed to the user and which is unique within the context of the system

Eg This would be the CPSO License for practitioner PV1171

name 11 HumanName

A name associated with the person

family 11 string Practitioner Last Name PV1172 given 12 string Practitioner First Name PV1173

extension

01 Practitioner middle name this is an extension of given name

PV1174

url 11 uri httphl7orgfhirStructureDefinitioniso21090-EN-qualifier

valueCode

11 code Fixed value ldquoMIDrdquo

Value must be from Valueset httphl7orgfhirValueSetname-part-qualifier

prefix 01 string Parts that come before the name

PV1176

suffix 01 string Parts that come after the name

PV1175

qualification 01 BackboneElement

Qualifications obtained by training and certification

code 11 CodebaleConcept

Coded representation of the qualification

PV11713

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 34: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 31

4310 Organization Profile (Ordering Facility)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent ordering facility which is reference from Procedure resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

OLIS Org id URI

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ORC216

name 11 string A name associated with the organization ORC211 address 01 ContactPoi

nt Organization address ORC22

type 11 code Address Type (Postal Physical Both) ORC227 line 11 string Street name number ORC221 city 11 string Name of city town and etc ORC223 state 11 string ValueSet for province Use of contact point ORC224 postalCode 11 string Postal Code for area ORC225 country 11 string Country ORC226

4311 Organization Profile (Performing Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent performing laboratory which is reference from Observation resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri Namespace in which set of possible id OLIS Org id URI

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 35: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 32

Name Card Type ValueVocab Description Comments

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR66

name 11 string A name associated with the organization ZBR61 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR77 line 11 string Street name number ZBR71 city 11 string Name of city town and etc ZBR73 state 11 string ValueSet for province Use of contact point ZBR74 postalCode 11 string Postal Code for area ZBR75 country 11 string Country ZBR76

4312 Organization Profile (Reporting Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent reporting laboratory which is reference from DiagnosticReport resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri

httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR46

name 11 string A name associated with the organization ZBR41 address 01 ContactPoi

nt Organization address

type 11 code Address Type (Postal Physical Both) ZBR57 line 11 string Street name number ZBR51

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 36: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 33

Name Card Type ValueVocab Description Comments

city 11 string Name of city town and etc ZBR53 state 11 string ValueSet for province Use of contact point ZBR54 postalCode 11 string Postal Code for area ZBR55 country 11 string Country ZBR56

4313 Organization Profile (Specimen Collector Center)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent specimen collector center which is extension reference from Specimen resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR362

name 11 string A name associated with the organization ZBR31

4314 Organization Profile (Test Request Placer)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent test request placer which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 37: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 34

Name Card Type ValueVocab Description Comments

system 11 uri httpehealthontariocaOLISfhirStructureDefinitionidentifier-laboratory-id

Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR262

name 11 string A name associated with the organization ZBR21

4315 Organization Profile (Destination Laboratory)

ca-on-Diagnostic-Organization profile based on httphl7orgfhirorganizationhtml

This resource will represent destination laboratory which is extension reference from ProcedureRequest resource

Name Card Type ValueVocab Description Comments

identifier 11 Identifier Identifier for the organization system 11 uri httpehealthontariocaOLISfhirStructur

eDefinitionidentifier-laboratory-id Namespace in which set of possible id values is unique (Laboratory system unique ID)

value 11 string The portion of the identifier typically displayed to the user and which is unique within the context of the system

ZBR862

name 11 string A name associated with the organization ZBR81

4316 Encounter Profile

ca-on-Diagnostic-Encounter profile based on httphl7orgfhirencounterhtml

Name Card Type ValueVocab Description Comments

status 11 code Status is mandatory in resource but it is a modifier so we can default it to false it will allow us

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 38: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 35

Name Card Type ValueVocab Description Comments

not to include it participant 02 Backbone

Element List of participants involved in the

encounter (attending admitting practitioners)

type 0 CodeableConcept

httphl7orgfhirvalueset-encounter-participant-typehtml

Role of participant in encounter ParticipantType (Extensible)

For ADM map to PV117 For ATND map to PV17

individual 11 reference Contained ca-on-Diagnostic-Practitioner (Practitioner) resource

A link to a resource representing the person to whom the diagnostic report has been performed

reference 11 string A reference to a location at which the other resource is found

Data Type Notes 44

441 Date

A date or partial date (eg just year or year + month) as used in human communication There is no time zone Dates SHALL be valid dates Regex -[0-9]4(-

(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])))

442 DateTime

A date date-time or partial date (eg just year or year + month) as used in human communication If hours and minutes are specified a time zone SHALL be

populated Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored Dates SHALL be valid dates The time 2400 is

not allowed

Regex -[0-9]4(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)(Z|(+|-)((0[0-9]|1[0-3])[0-5][0-

9]|1400)))))

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 39: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 36

443 Time

A time during the day with no date specified (can be converted to a Duration since midnight) Seconds must be provided due to schema type constraints but may

be zero-filled and may be ignored The time 2400 is not allowed and neither is a time zone

Regex ([01][0-9]|2[0-3])[0-5][0-9][0-5][0-9]([0-9]+)

444 URI

A Uniform Resource Identifier Reference (RFC 3986) Note URIs are case sensitive For UUID (urnuuid53fefa32-fcbb-4ff8-8a92-55ee120877b7) use all

lowercase

URIs can be absolute or relative and may have an optional fragment identifier

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 40: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 37

Appendix A JWT Autorisation header

HTTP Response Codes

This specification makes rules about the use of specific HTTP status codes in particular circumstances where the status codes SHALL map to particular states

correctly and only where the correct status code is not obvious Other HTTP status codes may be used for other states as appropriate and this particularly includes

various authentication related status codes and redirects Authentication redirects should not be interpreted to change the location of the resource itself

FHIR defines an OperationOutcome resource that can be used to convey specific detailed processable error information For a few combinations of interactions

and specific return codes an OperationOutcome is required to be returned as the content of the response The OperationOutcome may be returned with any

HTTP 4xx or 5xx response but is not required - many of these errors may be generated by generic server frameworks underlying a FHIR server

HIAL HTTP Response Codes

IANA Defined HTTP Status Codes

httpwwwianaorgassignmentshttp-status-codeshttp-status-codesxhtml

The IANA HTTP Status Codes listed below describes HTTP responses that may be processed by the HIAL without accessing the OLIS solution As a result

OperationOutcome resources would not be returned in these cases

Table 3 IANA-Defined HTTP Status Codes

Response Code Description FHIR Usage Notes

100 Continue

101 Switching Protocols

102 Processing

103-199 Unassigned

200 OK

201 Created

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 41: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 38

Response Code Description FHIR Usage Notes

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

207 Multi-Status

208 Already Reported

209-225 Unassigned

226 IM Used

227-299 Unassigned

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

305 Use Proxy

306 (Unused)

307 Temporary Redirect

308 Permanent Redirect

309-399 Unassigned

400 Bad Request Resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for

401 Unauthorized

402 Payment Required

403 Forbidden Authorization is required for the interaction that was attempted

404 Not Found Resource type not supported or not a FHIR end-point

405 Method Not Allowed The resource did not exist prior to the update and the server does

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 42: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 39

Response Code Description FHIR Usage Notes

not allow client defined ids

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed The clients criteria were not selective enough (eg multiple matches for Update)

413 Payload Too Large

414 URI Too Long

415 Unsupported Media Type

416 Range Not Satisfiable

417 Expectation Failed

418-420 Unassigned

421 Misdirected Request

422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules accompanied by an OperationOutcome resource providing additional detail

423 Locked

424 Failed Dependency

425 Unassigned

426 Upgrade Required

427 Unassigned

428 Precondition Required

429 Too Many Requests

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned

Page 43: OLIS HL7 FHIR Interface Implementation Guide for FHIR ... · OLIS HL7 FHIR Interface Implementation Guide for FHIR North Connectathon Version: draft 2017-04-26

eHealth Ontario OLIS FHIR Interface Implementation Guide Page 40

Response Code Description FHIR Usage Notes

430 Unassigned

431 Request Header Fields Too Large

432-450 Unassigned

451 Unavailable for Legal Reasons

452-499 Unassigned

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported

506 Variant Also Negotiates

507 Insufficient Storage

508 Loop Detected

509 Unassigned

510 Not Extended

511 Network Authentication Required

512-599 Unassigned