Grahame
Sheridan Cook
2012-03-19T11:12:07Z
2019-07-01T14:57:38Z
16.00
16020
27640
500
4520
814
2
False
False
FHIR Profile-authoring Spreadsheet
This spreadsheet is used to support the definition of profiles containing structures, extension definitions and or search criteria definitions. A complete set of instructions on the various tabs, columns and rules associated with populating this spreadsheet can be found here:
http://wiki.hl7.org?title=FHIR_Spreadsheet_Authoring
As well, additional guidance on profile-creation can be found here:
http://wiki.hl7.org?title=FHIR_Spreadsheet_Profile_Authoring
3
4
False
False
Name
Value
id
access-observation-gen-pat
name
ACCESS Health Observation (General Labs Patient)
author.name
Canada Health Infoway
author.reference
http://infoway-inforoute.ca
code
description
Constraints on the Observation resource to reflect source data mappings for the ACCESS Health project. Focus f this profile is on display of general lab information to citizen/patient viewers.
status
draft
date
2019-03-21T00:00:00.000
published.structure
access-observation-gen-pat
version
0.01
extension.uri
http://infoway-inforoute.ca/fhir/StructureDefinition/access-observation-gen-pat
introduction
notes
600
600
1
1
1
1
0
3
1
2
0
11
False
False
Profile Name
The name of an element for the purposes of this profile (used for slicing, code generation, etc. (see wiki for more details)
Discriminator
relative path | ordered? (true/false) | rules (open/openAtEnd/closed) See wiki
Slice Description
Used when discriminator can't be specified to explain how to differentiate slices
Element
Format is ResourceName.componentName.componentName
Aliases
Other names - semi-colon separated
Card.
Min and max repetitions n..m
Inv.
Comma-delimited list of Ids from Invariant tab that controls appearance of this element
Type
Data type, resource reference, profiles, aggregations, class names, type references, etc. - see the wiki
Must Support
If Y, indicates the element must be supported by conformant systems. Defaults to N
Binding
Binding for coded data - either from local Bindings tab or declared elsewhere
Value
The fixed value for this element. XML for complex elements, string for simple data types
Fixed
Pattern
Like 'value' however while instance values must contain the specified components, they may contain others.
Example
An example of the expected sort of value for this element.
Max Length
The longest content allowed to be sent by conformant systems. Only allowed for simple data types
Short Name
Short description or code1 | code2 | code3 +
Definition
Full definition - required
Requirements
Why element/resource is needed or why selected constraints chosen
Comments
Additional notes for implementers
To Do
Things to bug you about if they're not done :>
Vendor Agnostic v2 Mapping
Nova Scotia- Meditech C/S Mapping
Change column name to one from mappingSpaces.xml. Add more if needed
Nova Scotia- Meditech Magic Mapping
Nove Scotia- Cerner Millennium Mapping
Ontario- OLIS Mapping
Prince Edward Island- Cerner Millennium Mapping
Display Hint
Provides guidance to narrative auto-generator. Check Wiki documentation
Committee Notes
Not published
AccessObservationGeneralLabPatient
Observation
DomainResource
Expected requirements for the observation resource when reflecting general lab data based on existing source mappings
Observation.identifier
Identifier
Business Identifier for observation
OBX-21
(Observation Instance Identifier)
Other suggested options if OBX-21 is not available:
OBR-2
(Placer Order Number) +
OBR-3
(Filler Order Number) +
OBX-3
(Observation Identifier)
OBR-3.1 + OBR-4.1
OBR-3.1 + OBR-4.1
OBR-20 + OBR-4.1
OBR-3.1
OBR-3.1 + OBR-4.1
Observation.partOf
Reference(Procedure)
Part of referenced event
OBR-26 + OBR-29
OBX-3.1 + OBX-4.1 + OBR-2.1 + OBR-3.1
not supported
OBR 2 + OBX 3
OBR-26 + OBR-29
OBR-26 + OBR-29
Observation.status
code
Y
OS
registered | preliminary | final | amended +
OBX-11
(Observation Result Status)
OBX-11 (Codes supported: P, F, C, D, A*, FOUT*)
OBX-11 (Codes supported: P, F, D, A*)
OBX-11 (Codes supported: P, F, C)
OBX-11 (Codes supported: P, F, C, N, W, X, Z)
OBX-11 (Codes upported: P, F, C, D, R, S, D, U, I)
Observation.category
1..*
CodeableConcept
Y
OCC
Classification of type of observation
Laboratory should be the default code used in this general lab profile. Other profiles may support other codes.
Observation.code
CodeableConcept
Y
OLIS
Type of observation (code / type)
OBX-3.1
(Observation Identifier ID/Print Number)
Other suggested options if OBX-3 is not available:
OBR-4
(Universal Service Identifier)
OBX-3.1
OBX-3.1
OBX-3.1
OBX-3.1
OBX-3.1 (Code set 72 with some ability to send LOINC if site selects "send nomenclature identifier")
Observation.subject
1..1
Reference(Patient){http://hl7.org/fhir/ca/core/StructureDefinition/profile-patient}
Y
Who and/or what the observation is about
PID-3
(Patient Identifier List) Other suggested options if PID-3 is not available or the patient resource is tied to provincial identifiers:
PID-2
PID-3
PID-3
PID-3
PID-3
PID-3
Observation.effectiveDateTime
dateTime
Y
Clinically relevant time/time-period for observation
OBX-14
(Date/Time of the Observation) Other suggested options if OBX-14 is not available:
OBR-7
OBX-14
Other suggested options if OBX-14 is not available: OBR-7
OBX-14
Other suggested options if OBX-14 is not available: OBR-7
OBX-14
Other suggested options if OBX-14 is not available: OBR-7
OBX-14
Other suggested options if OBX-14 is not available: OBR-7
OBX-14 or OBR-7
Observation.issued
Date/Time this version was made available
OBR-22
(Results Rpt/Status Chng - Date/Time +)
Other suggested options if OBR-22 is not available:
OBR-7
or
OBX-19
(if LIS is HL7 v2.4 or higher)
OBR-22
Other suggested options if OBR-22 is not available: OBR-7 or OBX-19 (if LIS is HL7 v2.4 or higher)
OBR-22
Other suggested options if OBR-22 is not available: OBR-7 or OBX-19 (if LIS is HL7 v2.4 or higher)
OBR-22
Other suggested options if OBR-22 is not available: OBR-7 or OBX-19 (if LIS is HL7 v2.4 or higher)
OBR-7 (Observation Date/Time #)
OBR-22
profile
Observation.performer
Reference(Practitioner | Organization)
Who is responsible for the observation
Observation.performer.practitioner
Reference(Practitioner){http://hl7.org/fhir/ca/core/StructureDefinition/profile-practitioner}
Practitioner responsible for the observation
OBR-32 (Principal Result Interpreter) or OBX-16 (Responsible Observer)
?
?
OBX-16 (not sent for all results)
?
OBR-32
Observation.performer.organization
Reference(Organization){http://hl7.org/fhir/ca/core/StructureDefinition/profile-organization}
Organization responsible for the observation
OBX-23
(when v2.5.1 or higher),
OBX-15
(Producer's ID) if supported, otherwise Z segments
ZPS-2
OBX-15
ZBR-6
Observation.value[x]
Quantity|CodeableConcept|string|boolean|integer|Range|Ratio|SampledData|time|dateTime|Period
Y
Actual result
OBX.2
(Value Type),
OBX.5
(Observation Value),
OBX.6
(Units)
OBX.2, OBX.5, OBX.6
OBX.2, OBX.5, OBX.6
OBX.2, OBX.5, OBX.6
OBX.2, OBX.5, OBX.6
OBX.2, OBX.5, OBX.6
Observation.dataAbsentReason
CodeableConcept
Y
DAR
Why the result is missing
OBX-11*
(Observation Result Status)
OBX-11*
OBX-11*
None
OBX-11*
OBX-11*
Observation.interpretation
CodeableConcept
Y
OI
Codes signifying whether result is high, low, normal, compared to reference range
OBX-8
(Interpretation Codes)
OBX-8
OBX-8
OBX-8
OBX-8
OBX-8
Observation.note
Annotation
Comments about the observation
NTE-3
(Comment)
NTE-3
NTE-3
NTE-3
NTE-3
NTE-3
Note for implementors: This profile focuses on general lab results. It excludes pathology, microbiology, serotology, etc for two reasons: 1) The density and content of information in the various lab types are dramatically different from each other, these differences drive different information and interaction requirements from patients, and 2) there is a large degree of variance in how general lab results are formatted (more structured) and how other types of labs like pathology are structured (largely text based). Additional analysis required for microbiology, serotology, and pathology lab result types to determine level of structured data available
Observation.specimen
Reference(Specimen)
Specimen used for this observation
OBR-3.1
(Filler Order Number ID)
SPM-2
(Specimen ID) can be used in interfaces that are HL7 v2.5.1 and higher
OBR-3.1
OBR-3.1
OBR-20 (Filler Field 1+..Unformatted Millennium accension number)
OBR-3.1
SPM-2
Observation.referenceRange
BackboneElement
Provides guide for interpretation
OBX-7
(Reference Range)
OBX-7
OBX-7
OBX-7
OBX-7
OBX-7
Observation.referenceRange.appliesTo
CodeableConcept
v2NAT
Reference range population
OBX-10
(Nature of Abnormal Test)
OBX-10
OBX-10
OBX-10
Observation.referenceRange.text
string
Text based reference range in an observation
OBX-7
(Reference Range)
OBX-7
OBX-7
OBX-7
OBX-7
OBX-7
600
600
1
1
4
4
0
3
1
1
2
0
9
7
False
False
Profile Name
The name of an element for the purposes of this profile (used for slicing, code generation, etc. (see wiki for more details)
Discriminator
relative path | ordered? (true/false) | rules (open/openAtEnd/closed) See wiki
Slice Description
Used when discriminator can't be specified to explain how to differentiate slices
Element
Format is ResourceName.componentName.componentName
Aliases
Other names - semi-colon separated
Card.
Min and max repetitions n..m
Inv.
Comma-delimited list of Ids from Invariant tab that controls appearance of this element
Type
Data type, resource reference, profiles, aggregations, class names, type references, etc. - see the wiki
Must Support
If Y, indicates the element must be supported by conformant systems. Defaults to N
Binding
Binding for coded data - either from local Bindings tab or declared elsewhere
Value
The fixed value for this element. XML for complex elements, string for simple data types
Pattern
Like 'value' however while instance values must contain the specified components, they may contain others.
Example
An example of the expected sort of value for this element.
Max Length
The longest content allowed to be sent by conformant systems. Only allowed for simple data types
Short Name
Short description or code1 | code2 | code3 +
Definition
Full definition - required
Requirements
Why element/resource is needed or why selected constraints chosen
Comments
Additional notes for implementers
To Do
Things to bug you about if they're not done :>
RIM Mapping
E.g. RIMClass[classCode=foo,moodCode=bar].someAssociation[typeCode=code].attribute
v2 Mapping
E.g. SEG.1.2.3
??? Mapping
Change column name to one from mappingSpaces.xml. Add more if needed
Display Hint
Provides guidance to narrative auto-generator. Check Wiki documentation
Committee Notes
Not published
[ResourceOrDataTypeName]
DomainResource
[ResourceOrDataTypeName].[elementName1]
[ResourceOrDataTypeName].[elementName2]
600
600
1
1
4
15
0
3
1
1
2
0
0
False
False
Id
Unique Number
Name
Unique short label
Severity
Indicates impact of violating the invariant. (Defaults to 'error')
Context
Element path at which check should occur. E.g. ResourceName.element1.element2
English
English description of constraint
OCL
Optional - OCL expression of the rule
XPath
XPath 2 expression. See wiki or make Lloyd do it :>
600
600
1
1
2
2
0
3
1
2
0
0
0
R1:R1048576
False
False
Code
Format is ResourceName.componentName.componentName
Context Type
Identifies the type of context in which this particular extension is allowed to be used
Context
Place (or places - separate using ';') extension can be used. (path - resources & data types; URL - extensions)
Context Invariant
Name
Display
The English display name to use if auto-rendering the extension
Aliases
Other names - semi-colon separated
Card.
Min and max repetitions n..m
Inv.
Comma-delimited list of Ids from Invariant tab that controls appearance of this element
Type
Data type, resource reference, profiles, aggregations, class names, type references, etc. - see the wiki
Is Modifier
If Y, indicates this element modifies the meaning of sibling or descendant elements. Defaults to N
Modifier Reason
Binding
Binding for coded data - either from local Bindings tab or declared elsewhere
Pattern
Like 'value' however while instance values must contain the specified components, they may contain others.
Default Value
Example
An example of the expected sort of value for this element.
Max Length
The maximum length for Maximum length (length all systems must support). Only allowed for simple data types
Short Name
Short description or code1 | code2 | code3 +
Definition
Full definition - required
Requirements
Why element/resource is needed or why selected constraints chosen
Comments
Additional notes for implementers
To Do
Things to bug you about if they're not done :>
RIM Mapping
E.g. RIMClass[classCode=foo,moodCode=bar].someAssociation[typeCode=code].attribute
v2 Mapping
E.g. SEG.1.2.3
??? Mapping
Change column name to one from mappingSpaces.xml. Add more if needed
Display Hint
Provides guidance to narrative auto-generator. Check Wiki documentation
Committee Notes
Not published
600
600
1
1
1
1
0
3
1
2
0
False
False
Id
Unique Number
Name
Unique short label
Severity
Indicates impact of violating the invariant. (Defaults to 'error')
Context
Element path at which check should occur. E.g. ResourceName.element1.element2
English
English description of constraint
OCL
Optional - OCL expression of the rule
XPath
XPath 2 expression. See wiki or make Lloyd do it :>
False
False
Name
Unique name for search parameter - required, lower-case, dash-delimited string
Type
Data type for parameter
Target Types
Comma delimited list of targed resources
Path
Corresponding resource element. E.g. ResourceName.node1.node2
Description
Explanation of param. Will default if omitted and Path is specified, otherwise it is required
1
1
1
1
0
3
1
2
0
False
False
Name
The name of the operation or parameter (parameters prefixed by operation name + ".")
Use
"System | Resource | Instance" (operation) "In" or "Out" (parameter)
Min
Minimum cardinality for a parameter (must be a non-negative integer)
Max
maximum cardinality for a parameter - must be "*" or a positive integer
Type
query/operation for operation; data type for a parameter
Profile
Profile that must apply to parameter's type
Title
The descriptive label for the operation
Documentation
Explanation of the operation or parameter
Footer
Additional usage notes for an operation
1
1
1
1
0
3
1
2
0
0
False
False
Binding Name
Unique name across all resources
Definition
Formal description of the types of codes allowed for elements with this binding
Binding
How is the set of codes defined?
Conformance
Must implementations use this value set?
Reference
#tab-name or value set filename(without extension) or URL for reference
Description
Text to display for reference bindings (not used otherwise)
OID
The OID for the code list if one already exists. (If omitted, one will be assigned)
URI
Full URI for the code list. (If not specified, defaults to http://hl7.org/fhir/ValueSet
Website/Email
Contact information for the code list (if different from standard HL7 FHIR contact info)
Copyright
Copyright information associated with the code list. If not specified, Public Domain assumed
v2
uri of v2 value set mapped to
v3
uri of v3 value set mapped to
Committee Notes
Unpublished notes
OCC
Observation Category Codes
value set
Preferred
http://hl7.org/fhir/ValueSet/observation-category
Observation Category Codes
DAR
Data Absent Reason
value set
extensible
http://hl7.org/fhir/ValueSet/data-absent-reason
Used to specify why the normally expected content of the data element is missing.
OI
Observation Interpretation
value set
extensible
http://hl7.org/fhir/ValueSet/observation-interpretation
Observation Interpretation Codes
OS
Observation Status
value set
required
http://hl7.org/fhir/ValueSet/observation-status
Codes providing the status of an observation.
LC
LOINC Codes
value set
example
http://hl7.org/fhir/ValueSet/observation-codes
Value set containing all LOINC codes
OM
Observation Methods
value set
example
http://hl7.org/fhir/ValueSet/observation-methods
Observation Methods
ORRAP
Observation Reference Range Applies To Codes
value set
example
http://hl7.org/fhir/ValueSet/referencerange-appliesto
Observation Reference Range Applies To Codes
v2NAT
v2 Nature of abnormal test
value set
example
http://terminology.hl7.org/ValueSet/v2-0080
FHIR Value set/code system definition for HL7 v2 table 0080 ( NATURE OF ABNORMAL TESTING)
OLIS
OLIS Observation Codes
value set
example
http://ehealthontario.ca/fhir/ValueSet/lab/observation-codes
Observation codes supported by eHealth Ontario. The Observation codes are found in the Test Result Nomenclatures tab of the downloadable excel spreadsheet. Note: REFER TO THE LATEST OLIS NOMENCLATURE FILE https://www.ehealthontario.on.ca/en/olis-nomenclature
This value set includes codes from the following code systems: https://loinc.org/ , http://ehealthontario.ca/fhir/NamingSystem/lab/observation-temp-codes
600
600
1
1
1
1
0
3
1
2
0
17
False
False
Code
The code to be sent over the wire
Id
Unique number for the code. Required when System is not specified, not permitted otherwise
System
The URL of the external code system from which the list is selected. Must be the same for all codes if specified.
Parent
The code this code is a specialization of (if any). Content should be "#" + the Id of the parent code
Display
Display value for code. Omit if the code *is* the display value (as for internal codes)
Definition
Meaning of the code. Include unless meaning obvious to all users. Required if display not
v2
Mappings to v2 codes - See wiki for syntax
v3
Mappings to v3 codes - See wiki for syntax
Committee Notes
Additional notes about the code. Not published
1
1
1
1
0
3
1
2
0
0
0
R1:R1048576
False
False