Clinical Study Schedule of Activities, published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/Vulcan-schedule-ig/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Extension: SoA TimePoint Specification

SoA TimePoint Attribute Extension

Context of Use

This extension may be used on the following element(s)

• Element ID: PlanDefinition.action

Usage info

Usages:

• Use this Extension: SOA PlanDefinition
• Examples for this Extension: Levothroxine-Monitoring-Schedule, Levothroxine-Monitoring-Titration-Activities, dynamic-visit-schedule-exit-example-PlanDefinition, dynamic-visit-schedule-multiple-paths and dynamic-visit-schedules-cycles-scheduled-interactions

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description Differentials, Snapshots, and other representations.

• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Extension		0..*	Extension	SoA TimePoint Specification
Slices for extension				Content/Rules for all slices
extension:soaTimePointType		0..1	Extension	Extension
extension		0..0		Extension
url		1..1	uri	"soaTimePointType"
value[x]		0..1	string	Value of extension
extension:soaTimePointSubType		0..1	Extension	Extension
extension		0..0		Extension
url		1..1	uri	"soaTimePointSubType"
value[x]		0..1	string	Value of extension
extension:soaPlannedTimePoint		0..1	Extension	Extension
extension		0..0		Extension
url		1..1	uri	"soaPlannedTimePoint"
value[x]		0..1	SimpleQuantity	Value of extension
extension:soaPlannedRange		0..1	Extension	Extension
extension		0..0		Extension
url		1..1	uri	"soaPlannedRange"
value[x]		0..1	Range	Value of extension
extension:soaReferenceTimePoint		0..1	Extension	Extension
extension		0..0		Extension
url		1..1	uri	"soaReferenceTimePoint"
value[x]		0..1	string	Value of extension
extension:soaRangeFromTimePoint		0..1	Extension	Extension
extension		0..0		Extension
url		1..1	uri	"soaRangeFromTimePoint"
value[x]		0..1	string	Value of extension
extension:soaPlannedDuration		0..1	Extension	Extension
extension		0..0		Extension
url		1..1	uri	"soaPlannedDuration"
value[x]		0..1	Duration	Value of extension
extension:soaRepeatAllowed		0..1	Extension	Extension
extension		0..0		Extension
url		1..1	uri	"soaRepeatAllowed"
value[x]		0..1	boolean	Value of extension
url		1..1	uri	"http://hl7.org/fhir/uv/vulcan-schedule/StructureDefinition/soaTimepoint"
value[x]		0..0		Value of extension
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Extension		0..*	Extension	SoA TimePoint Specification
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:soaTimePointType		0..1	Extension	Extension
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url	Σ	1..1	uri	"soaTimePointType"
value[x]	Σ	0..1	string	Value of extension
extension:soaTimePointSubType		0..1	Extension	Extension
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url	Σ	1..1	uri	"soaTimePointSubType"
value[x]	Σ	0..1	string	Value of extension
extension:soaPlannedTimePoint		0..1	Extension	Extension
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url	Σ	1..1	uri	"soaPlannedTimePoint"
value[x]	Σ	0..1	SimpleQuantity	Value of extension
extension:soaPlannedRange		0..1	Extension	Extension
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url	Σ	1..1	uri	"soaPlannedRange"
value[x]	Σ	0..1	Range	Value of extension
extension:soaReferenceTimePoint		0..1	Extension	Extension
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url	Σ	1..1	uri	"soaReferenceTimePoint"
value[x]	Σ	0..1	string	Value of extension
extension:soaRangeFromTimePoint		0..1	Extension	Extension
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url	Σ	1..1	uri	"soaRangeFromTimePoint"
value[x]	Σ	0..1	string	Value of extension
extension:soaPlannedDuration		0..1	Extension	Extension
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url	Σ	1..1	uri	"soaPlannedDuration"
value[x]	Σ	0..1	Duration	Value of extension
extension:soaRepeatAllowed		0..1	Extension	Extension
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url	Σ	1..1	uri	"soaRepeatAllowed"
value[x]	Σ	0..1	boolean	Value of extension
url	Σ	1..1	uri	"http://hl7.org/fhir/uv/vulcan-schedule/StructureDefinition/soaTimepoint"
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
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()

Summary

Complex Extension: SoA TimePoint Attribute Extension

• soaTimePointType: string: An Extension
• soaTimePointSubType: string: An Extension
• soaPlannedTimePoint: Quantity: An Extension
• soaPlannedRange: Range: An Extension
• soaReferenceTimePoint: string: An Extension
• soaRangeFromTimePoint: string: An Extension
• soaPlannedDuration: Duration: An Extension
• soaRepeatAllowed: boolean: An Extension

Maturity: 2

Differential ViewDifferential View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Extension		0..*	Extension	SoA TimePoint Specification
Slices for extension				Content/Rules for all slices
extension:soaTimePointType		0..1	Extension	Extension
extension		0..0		Extension
url		1..1	uri	"soaTimePointType"
value[x]		0..1	string	Value of extension
extension:soaTimePointSubType		0..1	Extension	Extension
extension		0..0		Extension
url		1..1	uri	"soaTimePointSubType"
value[x]		0..1	string	Value of extension
extension:soaPlannedTimePoint		0..1	Extension	Extension
extension		0..0		Extension
url		1..1	uri	"soaPlannedTimePoint"
value[x]		0..1	SimpleQuantity	Value of extension
extension:soaPlannedRange		0..1	Extension	Extension
extension		0..0		Extension
url		1..1	uri	"soaPlannedRange"
value[x]		0..1	Range	Value of extension
extension:soaReferenceTimePoint		0..1	Extension	Extension
extension		0..0		Extension
url		1..1	uri	"soaReferenceTimePoint"
value[x]		0..1	string	Value of extension
extension:soaRangeFromTimePoint		0..1	Extension	Extension
extension		0..0		Extension
url		1..1	uri	"soaRangeFromTimePoint"
value[x]		0..1	string	Value of extension
extension:soaPlannedDuration		0..1	Extension	Extension
extension		0..0		Extension
url		1..1	uri	"soaPlannedDuration"
value[x]		0..1	Duration	Value of extension
extension:soaRepeatAllowed		0..1	Extension	Extension
extension		0..0		Extension
url		1..1	uri	"soaRepeatAllowed"
value[x]		0..1	boolean	Value of extension
url		1..1	uri	"http://hl7.org/fhir/uv/vulcan-schedule/StructureDefinition/soaTimepoint"
value[x]		0..0		Value of extension
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Extension		0..*	Extension	SoA TimePoint Specification
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:soaTimePointType		0..1	Extension	Extension
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url	Σ	1..1	uri	"soaTimePointType"
value[x]	Σ	0..1	string	Value of extension
extension:soaTimePointSubType		0..1	Extension	Extension
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url	Σ	1..1	uri	"soaTimePointSubType"
value[x]	Σ	0..1	string	Value of extension
extension:soaPlannedTimePoint		0..1	Extension	Extension
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url	Σ	1..1	uri	"soaPlannedTimePoint"
value[x]	Σ	0..1	SimpleQuantity	Value of extension
extension:soaPlannedRange		0..1	Extension	Extension
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url	Σ	1..1	uri	"soaPlannedRange"
value[x]	Σ	0..1	Range	Value of extension
extension:soaReferenceTimePoint		0..1	Extension	Extension
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url	Σ	1..1	uri	"soaReferenceTimePoint"
value[x]	Σ	0..1	string	Value of extension
extension:soaRangeFromTimePoint		0..1	Extension	Extension
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url	Σ	1..1	uri	"soaRangeFromTimePoint"
value[x]	Σ	0..1	string	Value of extension
extension:soaPlannedDuration		0..1	Extension	Extension
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url	Σ	1..1	uri	"soaPlannedDuration"
value[x]	Σ	0..1	Duration	Value of extension
extension:soaRepeatAllowed		0..1	Extension	Extension
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url	Σ	1..1	uri	"soaRepeatAllowed"
value[x]	Σ	0..1	boolean	Value of extension
url	Σ	1..1	uri	"http://hl7.org/fhir/uv/vulcan-schedule/StructureDefinition/soaTimepoint"
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
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()

Summary

Complex Extension: SoA TimePoint Attribute Extension

• soaTimePointType: string: An Extension
• soaTimePointSubType: string: An Extension
• soaPlannedTimePoint: Quantity: An Extension
• soaPlannedRange: Range: An Extension
• soaReferenceTimePoint: string: An Extension
• soaRangeFromTimePoint: string: An Extension
• soaPlannedDuration: Duration: An Extension
• soaRepeatAllowed: boolean: An Extension

Maturity: 2

Other representations of profile: CSV, Excel, Schematron