TW Core Observation Screening Assessment - 臺灣核心實作指引(TW Core IG) v0.3.2

臺灣核心實作指引(TW Core IG)
0.3.2 - Trial Use

This page is part of the 臺灣核心實作指引(TW Core IG) (v0.3.2: Releases) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: TW Core Observation Screening Assessment

Official URL: https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/Observation-screening-assessment-twcore				Version: 0.3.2
Active as of 2024-12-12			Computable Name: TWCoreObservationScreeningAssessment

此臺灣核心-健康狀態篩檢與評估（TW Core Observation Screening Assessment） Profile說明本IG如何進一步定義FHIR的Observation Resource以呈現健康狀態篩檢與評估資料。

Usage:

Refer to this Resource Profile: TW Core Observation Screening Assessment
Examples for this Resource Profile: Observation/obs-screening-assessment-example

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

Differential Table
Key Elements Table
Snapshot Table
Statistics/References
All

This structure is derived from Observation

Name	Flags	Card.	Type	Description & Constraints
Observation	C	0..*	Observation	Measurements and simple assertions tw-core-4: If there is no component or hasMember element then either a value[x] or a data absent reason must be present.
status	S	1..1	code	registered \| preliminary \| final \| amended +
Slices for category	S	1..*	CodeableConceptTW	Classification of type of observation Slice: Unordered, Open by pattern:$this
category:survey	S	1..1	CodeableConcept	Classification of type of observation Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
code		1..1	code	Symbol in syntax defined by the system Fixed Value: survey
category:twcore	S	0..*	CodeableConcept	Classification of type of observation Binding: 臺灣衛福部資訊處Observation Screening Assessment類型值集 (required)
code	S	1..1	CodeableConceptTW	概念（Concept）— 參照一個專門術語或只是文字表述 Binding: LOINC篩檢與評估值集 (preferred)
subject	S	1..1	Reference(TW Core Patient \| TW Core Location \| Group \| Device)	Who and/or what the observation is about
effective[x]	SC	0..1		Clinically relevant time/time-period for observation tw-core-3: Datetime must be at least to day.
effectiveDateTime			dateTime S
effectivePeriod			Period
effectiveTiming			Timing
effectiveInstant			instant
performer	S	0..*	Reference(TW Core Practitioner \| TW Core Organization \| TW Core Patient \| TW Core PractitionerRole \| TW Core CareTeam \| TW Core RelatedPerson)	Who is responsible for the observation
value[x]	SC	0..1		Actual result tw-core-5: SHALL use UCUM for coded quantity units.
valueQuantity			Quantity S
valueCodeableConcept			CodeableConcept S
valueString			string S
valueBoolean			boolean
valueInteger			integer
valueRange			Range
valueRatio			Ratio
valueSampledData			SampledData
valueTime			time
valueDateTime			dateTime
valuePeriod			Period
dataAbsentReason	S	0..1	CodeableConceptTW	概念（Concept）— 參照一個專門術語或只是文字表述
hasMember	S	0..*	Reference(TW Core Observation Screening Assessment \| TW Core QuestionnaireResponse \| MolecularSequence)	Related resource that belongs to the Observation group
derivedFrom	S	0..*	Reference(TW Core Observation Screening Assessment S \| TW Core QuestionnaireResponse S \| TW Core DocumentReference \| ImagingStudy \| Media \| MolecularSequence)	Related measurements the observation is made from
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Observation.category:twcore	required	TWObservationScreeningAssessmentCategory (a valid code from 臺灣衛福部資訊處類型代碼) `https://twcore.mohw.gov.tw/ig/twcore/ValueSet/observation-screening-assessment-category` from this IG
Observation.code	preferred	LOINCSurveyCode `https://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-survey-codes` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
tw-core-3	error	Observation.effective[x]	Datetime must be at least to day. : $this is dateTime implies $this.toString().length() >= 10
tw-core-4	error	Observation	If there is no component or hasMember element then either a value[x] or a data absent reason must be present. : (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
tw-core-5	error	Observation.value[x]	SHALL use UCUM for coded quantity units. : ofType(Quantity).system.empty() or ofType(Quantity).system = 'http://unitsofmeasure.org'

Name	Flags	Card.	Type	Description & Constraints
Observation	C	0..*	Observation	Measurements and simple assertions dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present tw-core-4: If there is no component or hasMember element then either a value[x] or a data absent reason must be present.
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!SΣ	1..1	code	registered \| preliminary \| final \| amended + Binding: ObservationStatus (required): Codes providing the status of an observation. ele-1: All FHIR elements must have a @value or children
Slices for category	S	1..*	CodeableConceptTW	Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. ele-1: All FHIR elements must have a @value or children
category:survey	S	1..1	CodeableConcept	Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
code		1..1	code	Symbol in syntax defined by the system Fixed Value: survey
category:twcore	S	0..*	CodeableConcept	Classification of type of observation Binding: 臺灣衛福部資訊處Observation Screening Assessment類型值集 (required) ele-1: All FHIR elements must have a @value or children
code	S	1..1	CodeableConceptTW	概念（Concept）— 參照一個專門術語或只是文字表述 Binding: LOINC篩檢與評估值集 (preferred) ele-1: All FHIR elements must have a @value or children
subject	SΣ	1..1	Reference(TW Core Patient \| TW Core Location \| Group \| Device)	Who and/or what the observation is about ele-1: All FHIR elements must have a @value or children
effective[x]	SΣC	0..1		Clinically relevant time/time-period for observation ele-1: All FHIR elements must have a @value or children tw-core-3: Datetime must be at least to day.
effectiveDateTime			dateTime
performer	SΣ	0..*	Reference(TW Core Practitioner \| TW Core Organization \| TW Core Patient \| TW Core PractitionerRole \| TW Core CareTeam \| TW Core RelatedPerson)	Who is responsible for the observation ele-1: All FHIR elements must have a @value or children
value[x]	SΣC	0..1		Actual result ele-1: All FHIR elements must have a @value or children tw-core-5: SHALL use UCUM for coded quantity units.
valueQuantity			Quantity
valueCodeableConcept			CodeableConcept
valueString			string
dataAbsentReason	S	0..1	CodeableConceptTW	概念（Concept）— 參照一個專門術語或只是文字表述 Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. ele-1: All FHIR elements must have a @value or children
hasMember	SΣ	0..*	Reference(TW Core Observation Screening Assessment \| TW Core QuestionnaireResponse \| MolecularSequence)	Related resource that belongs to the Observation group ele-1: All FHIR elements must have a @value or children
derivedFrom	SΣ	0..*	Reference(TW Core Observation Screening Assessment \| TW Core QuestionnaireResponse)	Related measurements the observation is made from ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Observation.status	required	ObservationStatus `http://hl7.org/fhir/ValueSet/observation-status\|4.0.1` from the FHIR Standard
Observation.category	preferred	ObservationCategoryCodes `http://hl7.org/fhir/ValueSet/observation-category` from the FHIR Standard
Observation.category:survey	preferred	Pattern: survey `http://hl7.org/fhir/ValueSet/observation-category` from the FHIR Standard
Observation.category:twcore	required	TWObservationScreeningAssessmentCategory (a valid code from 臺灣衛福部資訊處類型代碼) `https://twcore.mohw.gov.tw/ig/twcore/ValueSet/observation-screening-assessment-category` from this IG
Observation.code	preferred	LOINCSurveyCode `https://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-survey-codes` from this IG
Observation.dataAbsentReason	extensible	DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Observation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Observation	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Observation	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Observation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Observation	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
obs-6	error	Observation	dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty()
obs-7	error	Observation	If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
tw-core-3	error	Observation.effective[x]	Datetime must be at least to day. : $this is dateTime implies $this.toString().length() >= 10
tw-core-4	error	Observation	If there is no component or hasMember element then either a value[x] or a data absent reason must be present. : (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
tw-core-5	error	Observation.value[x]	SHALL use UCUM for coded quantity units. : ofType(Quantity).system.empty() or ofType(Quantity).system = 'http://unitsofmeasure.org'

Description & Constraints

Observation

C

0..*

Observation

Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
tw-core-4: If there is no component or hasMember element then either a value[x] or a data absent reason must be present.

id

Σ

0..1

id

Logical id of this artifact

Terminology Bindings

Path Conformance ValueSet / Code URI

Observation.language

preferred

CommonLanguages

http://hl7.org/fhir/ValueSet/languages

from the FHIR Standard

Additional Bindings

Purpose

AllLanguages

Max Binding

Observation.status

required

ObservationStatus

http://hl7.org/fhir/ValueSet/observation-status|4.0.1

from the FHIR Standard

Observation.category

preferred

ObservationCategoryCodes

http://hl7.org/fhir/ValueSet/observation-category

from the FHIR Standard

Observation.category:survey

preferred

Pattern: survey

http://hl7.org/fhir/ValueSet/observation-category

from the FHIR Standard

Observation.category:twcore

required

TWObservationScreeningAssessmentCategory (a valid code from 臺灣衛福部資訊處類型代碼)

https://twcore.mohw.gov.tw/ig/twcore/ValueSet/observation-screening-assessment-category

from this IG

Observation.code

preferred

LOINCSurveyCode

https://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-survey-codes

from this IG

Observation.dataAbsentReason

extensible

DataAbsentReason

http://hl7.org/fhir/ValueSet/data-absent-reason

from the FHIR Standard

Observation.interpretation

extensible

ObservationInterpretationCodes

http://hl7.org/fhir/ValueSet/observation-interpretation

from the FHIR Standard

Observation.bodySite

example

SNOMEDCTBodyStructures

http://hl7.org/fhir/ValueSet/body-site

from the FHIR Standard

Observation.method

example

ObservationMethods

http://hl7.org/fhir/ValueSet/observation-methods

from the FHIR Standard

Observation.referenceRange.type

preferred

ObservationReferenceRangeMeaningCodes

http://hl7.org/fhir/ValueSet/referencerange-meaning

from the FHIR Standard

Observation.referenceRange.appliesTo

example

ObservationReferenceRangeAppliesToCodes

http://hl7.org/fhir/ValueSet/referencerange-appliesto

from the FHIR Standard

Observation.component.code

example

LOINCCodes (a valid code from LOINC)

http://hl7.org/fhir/ValueSet/observation-codes

from the FHIR Standard

Observation.component.dataAbsentReason

extensible

DataAbsentReason

http://hl7.org/fhir/ValueSet/data-absent-reason

from the FHIR Standard

Observation.component.interpretation

extensible

ObservationInterpretationCodes

http://hl7.org/fhir/ValueSet/observation-interpretation

from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Observation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Observation	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Observation	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Observation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Observation	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
obs-3	error	Observation.referenceRange	Must have at least a low or a high or text : low.exists() or high.exists() or text.exists()
obs-6	error	Observation	dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty()
obs-7	error	Observation	If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
tw-core-3	error	Observation.effective[x]	Datetime must be at least to day. : $this is dateTime implies $this.toString().length() >= 10
tw-core-4	error	Observation	If there is no component or hasMember element then either a value[x] or a data absent reason must be present. : (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
tw-core-5	error	Observation.value[x]	SHALL use UCUM for coded quantity units. : ofType(Quantity).system.empty() or ofType(Quantity).system = 'http://unitsofmeasure.org'

This structure is derived from Observation

Summary

Mandatory: 3 elements
Must-Support: 12 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

The element 1 is sliced based on the value of Observation.category

Differential View

This structure is derived from Observation

Name	Flags	Card.	Type	Description & Constraints
Observation	C	0..*	Observation	Measurements and simple assertions tw-core-4: If there is no component or hasMember element then either a value[x] or a data absent reason must be present.
status	S	1..1	code	registered \| preliminary \| final \| amended +
Slices for category	S	1..*	CodeableConceptTW	Classification of type of observation Slice: Unordered, Open by pattern:$this
category:survey	S	1..1	CodeableConcept	Classification of type of observation Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
code		1..1	code	Symbol in syntax defined by the system Fixed Value: survey
category:twcore	S	0..*	CodeableConcept	Classification of type of observation Binding: 臺灣衛福部資訊處Observation Screening Assessment類型值集 (required)
code	S	1..1	CodeableConceptTW	概念（Concept）— 參照一個專門術語或只是文字表述 Binding: LOINC篩檢與評估值集 (preferred)
subject	S	1..1	Reference(TW Core Patient \| TW Core Location \| Group \| Device)	Who and/or what the observation is about
effective[x]	SC	0..1		Clinically relevant time/time-period for observation tw-core-3: Datetime must be at least to day.
effectiveDateTime			dateTime S
effectivePeriod			Period
effectiveTiming			Timing
effectiveInstant			instant
performer	S	0..*	Reference(TW Core Practitioner \| TW Core Organization \| TW Core Patient \| TW Core PractitionerRole \| TW Core CareTeam \| TW Core RelatedPerson)	Who is responsible for the observation
value[x]	SC	0..1		Actual result tw-core-5: SHALL use UCUM for coded quantity units.
valueQuantity			Quantity S
valueCodeableConcept			CodeableConcept S
valueString			string S
valueBoolean			boolean
valueInteger			integer
valueRange			Range
valueRatio			Ratio
valueSampledData			SampledData
valueTime			time
valueDateTime			dateTime
valuePeriod			Period
dataAbsentReason	S	0..1	CodeableConceptTW	概念（Concept）— 參照一個專門術語或只是文字表述
hasMember	S	0..*	Reference(TW Core Observation Screening Assessment \| TW Core QuestionnaireResponse \| MolecularSequence)	Related resource that belongs to the Observation group
derivedFrom	S	0..*	Reference(TW Core Observation Screening Assessment S \| TW Core QuestionnaireResponse S \| TW Core DocumentReference \| ImagingStudy \| Media \| MolecularSequence)	Related measurements the observation is made from
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Observation.category:twcore	required	TWObservationScreeningAssessmentCategory (a valid code from 臺灣衛福部資訊處類型代碼) `https://twcore.mohw.gov.tw/ig/twcore/ValueSet/observation-screening-assessment-category` from this IG
Observation.code	preferred	LOINCSurveyCode `https://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-survey-codes` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
tw-core-3	error	Observation.effective[x]	Datetime must be at least to day. : $this is dateTime implies $this.toString().length() >= 10
tw-core-4	error	Observation	If there is no component or hasMember element then either a value[x] or a data absent reason must be present. : (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
tw-core-5	error	Observation.value[x]	SHALL use UCUM for coded quantity units. : ofType(Quantity).system.empty() or ofType(Quantity).system = 'http://unitsofmeasure.org'

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Observation	C	0..*	Observation	Measurements and simple assertions dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present tw-core-4: If there is no component or hasMember element then either a value[x] or a data absent reason must be present.
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!SΣ	1..1	code	registered \| preliminary \| final \| amended + Binding: ObservationStatus (required): Codes providing the status of an observation. ele-1: All FHIR elements must have a @value or children
Slices for category	S	1..*	CodeableConceptTW	Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. ele-1: All FHIR elements must have a @value or children
category:survey	S	1..1	CodeableConcept	Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
code		1..1	code	Symbol in syntax defined by the system Fixed Value: survey
category:twcore	S	0..*	CodeableConcept	Classification of type of observation Binding: 臺灣衛福部資訊處Observation Screening Assessment類型值集 (required) ele-1: All FHIR elements must have a @value or children
code	S	1..1	CodeableConceptTW	概念（Concept）— 參照一個專門術語或只是文字表述 Binding: LOINC篩檢與評估值集 (preferred) ele-1: All FHIR elements must have a @value or children
subject	SΣ	1..1	Reference(TW Core Patient \| TW Core Location \| Group \| Device)	Who and/or what the observation is about ele-1: All FHIR elements must have a @value or children
effective[x]	SΣC	0..1		Clinically relevant time/time-period for observation ele-1: All FHIR elements must have a @value or children tw-core-3: Datetime must be at least to day.
effectiveDateTime			dateTime
performer	SΣ	0..*	Reference(TW Core Practitioner \| TW Core Organization \| TW Core Patient \| TW Core PractitionerRole \| TW Core CareTeam \| TW Core RelatedPerson)	Who is responsible for the observation ele-1: All FHIR elements must have a @value or children
value[x]	SΣC	0..1		Actual result ele-1: All FHIR elements must have a @value or children tw-core-5: SHALL use UCUM for coded quantity units.
valueQuantity			Quantity
valueCodeableConcept			CodeableConcept
valueString			string
dataAbsentReason	S	0..1	CodeableConceptTW	概念（Concept）— 參照一個專門術語或只是文字表述 Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. ele-1: All FHIR elements must have a @value or children
hasMember	SΣ	0..*	Reference(TW Core Observation Screening Assessment \| TW Core QuestionnaireResponse \| MolecularSequence)	Related resource that belongs to the Observation group ele-1: All FHIR elements must have a @value or children
derivedFrom	SΣ	0..*	Reference(TW Core Observation Screening Assessment \| TW Core QuestionnaireResponse)	Related measurements the observation is made from ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Observation.status	required	ObservationStatus `http://hl7.org/fhir/ValueSet/observation-status\|4.0.1` from the FHIR Standard
Observation.category	preferred	ObservationCategoryCodes `http://hl7.org/fhir/ValueSet/observation-category` from the FHIR Standard
Observation.category:survey	preferred	Pattern: survey `http://hl7.org/fhir/ValueSet/observation-category` from the FHIR Standard
Observation.category:twcore	required	TWObservationScreeningAssessmentCategory (a valid code from 臺灣衛福部資訊處類型代碼) `https://twcore.mohw.gov.tw/ig/twcore/ValueSet/observation-screening-assessment-category` from this IG
Observation.code	preferred	LOINCSurveyCode `https://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-survey-codes` from this IG
Observation.dataAbsentReason	extensible	DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Observation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Observation	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Observation	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Observation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Observation	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
obs-6	error	Observation	dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty()
obs-7	error	Observation	If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
tw-core-3	error	Observation.effective[x]	Datetime must be at least to day. : $this is dateTime implies $this.toString().length() >= 10
tw-core-4	error	Observation	If there is no component or hasMember element then either a value[x] or a data absent reason must be present. : (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
tw-core-5	error	Observation.value[x]	SHALL use UCUM for coded quantity units. : ofType(Quantity).system.empty() or ofType(Quantity).system = 'http://unitsofmeasure.org'

Snapshot View

Description & Constraints

Observation

C

0..*

Observation

Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
tw-core-4: If there is no component or hasMember element then either a value[x] or a data absent reason must be present.

id

Σ

0..1

id

Logical id of this artifact

Terminology Bindings

Path Conformance ValueSet / Code URI

Observation.language

preferred

CommonLanguages

http://hl7.org/fhir/ValueSet/languages

from the FHIR Standard

Additional Bindings

Purpose

AllLanguages

Max Binding

Observation.status

required

ObservationStatus

http://hl7.org/fhir/ValueSet/observation-status|4.0.1

from the FHIR Standard

Observation.category

preferred

ObservationCategoryCodes

http://hl7.org/fhir/ValueSet/observation-category

from the FHIR Standard

Observation.category:survey

preferred

Pattern: survey

http://hl7.org/fhir/ValueSet/observation-category

from the FHIR Standard

Observation.category:twcore

required

TWObservationScreeningAssessmentCategory (a valid code from 臺灣衛福部資訊處類型代碼)

https://twcore.mohw.gov.tw/ig/twcore/ValueSet/observation-screening-assessment-category

from this IG

Observation.code

preferred

LOINCSurveyCode

https://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-survey-codes

from this IG

Observation.dataAbsentReason

extensible

DataAbsentReason

http://hl7.org/fhir/ValueSet/data-absent-reason

from the FHIR Standard

Observation.interpretation

extensible

ObservationInterpretationCodes

http://hl7.org/fhir/ValueSet/observation-interpretation

from the FHIR Standard

Observation.bodySite

example

SNOMEDCTBodyStructures

http://hl7.org/fhir/ValueSet/body-site

from the FHIR Standard

Observation.method

example

ObservationMethods

http://hl7.org/fhir/ValueSet/observation-methods

from the FHIR Standard

Observation.referenceRange.type

preferred

ObservationReferenceRangeMeaningCodes

http://hl7.org/fhir/ValueSet/referencerange-meaning

from the FHIR Standard

Observation.referenceRange.appliesTo

example

ObservationReferenceRangeAppliesToCodes

http://hl7.org/fhir/ValueSet/referencerange-appliesto

from the FHIR Standard

Observation.component.code

example

LOINCCodes (a valid code from LOINC)

http://hl7.org/fhir/ValueSet/observation-codes

from the FHIR Standard

Observation.component.dataAbsentReason

extensible

DataAbsentReason

http://hl7.org/fhir/ValueSet/data-absent-reason

from the FHIR Standard

Observation.component.interpretation

extensible

ObservationInterpretationCodes

http://hl7.org/fhir/ValueSet/observation-interpretation

from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Observation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Observation	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Observation	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Observation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Observation	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
obs-3	error	Observation.referenceRange	Must have at least a low or a high or text : low.exists() or high.exists() or text.exists()
obs-6	error	Observation	dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty()
obs-7	error	Observation	If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
tw-core-3	error	Observation.effective[x]	Datetime must be at least to day. : $this is dateTime implies $this.toString().length() >= 10
tw-core-4	error	Observation	If there is no component or hasMember element then either a value[x] or a data absent reason must be present. : (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
tw-core-5	error	Observation.value[x]	SHALL use UCUM for coded quantity units. : ofType(Quantity).system.empty() or ofType(Quantity).system = 'http://unitsofmeasure.org'

This structure is derived from Observation

Summary

Mandatory: 3 elements
Must-Support: 12 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

The element 1 is sliced based on the value of Observation.category

Other representations of profile: CSV, Excel, Schematron

Notes:

以下概述了此Profile所需的RESTful FHIR互動功能。有關TW Core IG支援的RESTful互動功能的完整清單，請參閱TW Core Server能力聲明。

必須支援以下查詢參數：

必須（SHALL） 支援透過查詢參數 patient 及 category 查詢所有Observation：
(如何透過reference查詢)
(如何透過token查詢)
GET [base]/Observation?patient={Type/}[id]&category=https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/category-code-tw|survey

例子：
(1) GET [base]/Observation?patient=Patient/pat-example&category=https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/category-code-tw|survey
必須（SHALL） 支援透過查詢參數 patient 及 code 查詢所有Observation：
(如何透過reference查詢)
(如何透過token查詢)
GET [base]/Observation?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}

例子：
(1) GET [base]/Observation?patient=Patient/pat-example&code=http://loinc.org|9271-8,http://loinc.org|32405-3,http://loinc.org|32403-8
必須（SHALL） 支援透過查詢參數 patient 、 category 及 date 查詢所有Observation：
(如何透過reference查詢)
(如何透過token查詢)
(如何透過date查詢)
GET [base]/Observation?patient={Type/}[id]&category=https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/category-code-tw|survey&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

例子：
(1) GET [base]/Observation?patient=Patient/pat-example&category=https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/category-code-tw|survey&date=ge2020-01-01T00:00:00Z

建議應該支援以下查詢參數：

建議應該（SHOULD） 支援透過查詢參數 patient 、 category 及 status 查詢所有Observation：
(如何透過reference查詢)
(如何透過token查詢)
GET [base]/Observation?patient={Type/}[id]&category=https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/category-code-tw|survey&status={system|}[code]{,{system|}[code],...}

例子：
(1) GET [base]/Observation?patient=Patient/pat-example&category=https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/category-code-tw|survey&status=final
建議應該（SHOULD） 支援透過查詢參數 patient 、 category 及 _lastUpdated 查詢所有Observation：
(如何透過reference查詢)
(如何透過token查詢)
(如何透過date查詢)
GET [base]/Observation?patient={Type/}[id]&category={system|}[code]&_lastUpdated={gt|lt|ge|le}[date]{&_lastUpdated={gt|lt|ge|le}[date]&...}

例子：
(1) GET [base]/Observation?patient=Patient/pat-example&category=https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/category-code-tw|survey&_lastUpdated=ge2024-01-01T00:00:00Z
支援透過查詢參數 patient 、 code 及 date 查詢所有Observation：
(如何透過reference查詢)
(如何透過token查詢)
(如何透過date查詢)
GET [base]/Observation?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

例子：
(1) GET [base]/Observation?patient=Patient/pat-example&code=http://loinc.org|9271-8&date=ge2020-01-01T00:00:00Z

IG © 2022+ 衛生福利部. Package tw.gov.mohw.twcore#0.3.2 based on FHIR 4.0.1. Generated 2024-12-12
Links: Table of Contents | QA Report | Version History | 聯絡我們