HL7 Czech Hospital Discharge Report Implementation Guide, published by HL7 Czech Republic. This guide is not an authorized publication; it is the continuous build for version 0.0.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-cz/hdr/ and changes regularly. See the Directory of published versions

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

Data Type Profile: Dosage: Obligations (HDR CZ) - hospital stay

Profile for Dosage with obligations (HDR CZ) - hospital stay.

Usages:

• This DataType Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Dosage		0..*	Dosage	How the medication is/was taken or should be taken
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
route	OΣ	0..1	CodeableConcept	How drug should enter body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. Obligations Actor SHOULD:populate-if-known HdrCreator-L2 SHOULD:display HdrConsumer-L2 SHOULD:populate-if-known HdrCreator-L3 SHOULD:display HdrConsumer-L3
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Dosage.route	example	SNOMEDCTRouteCodes http://hl7.org/fhir/ValueSet/route-codes|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

This structure is derived from Dosage

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Dosage		0..*	Dosage	How the medication is/was taken or should be taken
timing
repeat
duration	O	0..1	decimal	How long when it happens Obligations Actor SHALL:able-to-populate HdrCreator-L2 SHALL:display HdrConsumer-L2 SHALL:able-to-populate HdrCreator-L3 SHALL:display HdrConsumer-L3
route	O	0..1	CodeableConcept	How drug should enter body Obligations Actor SHOULD:populate-if-known HdrCreator-L2 SHOULD:display HdrConsumer-L2 SHOULD:populate-if-known HdrCreator-L3 SHOULD:display HdrConsumer-L3
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Dosage		0..*	Dosage	How the medication is/was taken or should be taken
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
sequence	Σ	0..1	integer	The order of the dosage instructions
text	Σ	0..1	string	Free text dosage instructions e.g. SIG
additionalInstruction	Σ	0..*	CodeableConcept	Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".
patientInstruction	Σ	0..1	string	Patient or consumer oriented instructions
timing	Σ	0..1	Timing	When medication should be administered
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
event	Σ	0..*	dateTime	When the event occurs
repeat	ΣC	0..1	Element	When the event is to occur Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
bounds[x]	Σ	0..1		Length/Range of lengths, or (Start and/or end) limits
boundsDuration			Duration
boundsRange			Range
boundsPeriod			Period
count	Σ	0..1	positiveInt	Number of times to repeat
countMax	Σ	0..1	positiveInt	Maximum number of times to repeat
duration	OΣ	0..1	decimal	How long when it happens Obligations Actor SHALL:able-to-populate HdrCreator-L2 SHALL:display HdrConsumer-L2 SHALL:able-to-populate HdrCreator-L3 SHALL:display HdrConsumer-L3
durationMax	Σ	0..1	decimal	How long when it happens (Max)
durationUnit	Σ	0..1	code	s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM).
frequency	Σ	0..1	positiveInt	Event occurs frequency times per period
frequencyMax	Σ	0..1	positiveInt	Event occurs up to frequencyMax times per period
period	Σ	0..1	decimal	Event occurs frequency times per period
periodMax	Σ	0..1	decimal	Upper limit of period (3-4 hours)
periodUnit	Σ	0..1	code	s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM).
dayOfWeek	Σ	0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required)
timeOfDay	Σ	0..*	time	Time of day for action
when	Σ	0..*	code	Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule.
offset	Σ	0..1	unsignedInt	Minutes from event (before or after)
code	Σ	0..1	CodeableConcept	BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.
asNeeded[x]	Σ	0..1		Take "as needed" (for x) Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.
asNeededBoolean			boolean
asNeededCodeableConcept			CodeableConcept
site	Σ	0..1	CodeableConcept	Body site to administer to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.
route	OΣ	0..1	CodeableConcept	How drug should enter body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. Obligations Actor SHOULD:populate-if-known HdrCreator-L2 SHOULD:display HdrConsumer-L2 SHOULD:populate-if-known HdrCreator-L3 SHOULD:display HdrConsumer-L3
method	Σ	0..1	CodeableConcept	Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
doseAndRate	Σ	0..*	Element	Amount of medication administered
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
type	Σ	0..1	CodeableConcept	The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified.
dose[x]	Σ	0..1		Amount of medication per dose
doseRange			Range
doseQuantity			Quantity(SimpleQuantity)
rate[x]	Σ	0..1		Amount of medication per unit of time
rateRatio			Ratio
rateRange			Range
rateQuantity			Quantity(SimpleQuantity)
maxDosePerPeriod	Σ	0..1	Ratio	Upper limit on medication per unit of time
maxDosePerAdministration	Σ	0..1	SimpleQuantity(4.0.1)	Upper limit on medication per administration
maxDosePerLifetime	Σ	0..1	SimpleQuantity(4.0.1)	Upper limit on medication per lifetime of the patient
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Dosage.additionalInstruction	example	SNOMEDCTAdditionalDosageInstructions http://hl7.org/fhir/ValueSet/additional-instruction-codes|4.0.1 From the FHIR Standard
Dosage.timing.repeat.durationUnit	required	UnitsOfTime http://hl7.org/fhir/ValueSet/units-of-time|4.0.1 From the FHIR Standard
Dosage.timing.repeat.periodUnit	required	UnitsOfTime http://hl7.org/fhir/ValueSet/units-of-time|4.0.1 From the FHIR Standard
Dosage.timing.repeat.dayOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 From the FHIR Standard
Dosage.timing.repeat.when	required	EventTiming http://hl7.org/fhir/ValueSet/event-timing|4.0.1 From the FHIR Standard
Dosage.timing.code	preferred	TimingAbbreviation http://hl7.org/fhir/ValueSet/timing-abbreviation|4.0.1 From the FHIR Standard
Dosage.asNeeded[x]	example	SNOMEDCTMedicationAsNeededReasonCodes http://hl7.org/fhir/ValueSet/medication-as-needed-reason|4.0.1 From the FHIR Standard
Dosage.site	example	SNOMEDCTAnatomicalStructureForAdministrationSiteCodes http://hl7.org/fhir/ValueSet/approach-site-codes|4.0.1 From the FHIR Standard
Dosage.route	example	SNOMEDCTRouteCodes http://hl7.org/fhir/ValueSet/route-codes|4.0.1 From the FHIR Standard
Dosage.method	example	SNOMEDCTAdministrationMethodCodes http://hl7.org/fhir/ValueSet/administration-method-codes|4.0.1 From the FHIR Standard
Dosage.doseAndRate.type	example	DoseAndRateType http://hl7.org/fhir/ValueSet/dose-rate-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()
tim-1	error	Dosage.timing.repeat	if there's a duration, there needs to be duration units : duration.empty() or durationUnit.exists()
tim-2	error	Dosage.timing.repeat	if there's a period, there needs to be period units : period.empty() or periodUnit.exists()
tim-4	error	Dosage.timing.repeat	duration SHALL be a non-negative value : duration.exists() implies duration >= 0
tim-5	error	Dosage.timing.repeat	period SHALL be a non-negative value : period.exists() implies period >= 0
tim-6	error	Dosage.timing.repeat	If there's a periodMax, there must be a period : periodMax.empty() or period.exists()
tim-7	error	Dosage.timing.repeat	If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists()
tim-8	error	Dosage.timing.repeat	If there's a countMax, there must be a count : countMax.empty() or count.exists()
tim-9	error	Dosage.timing.repeat	If there's an offset, there must be a when (and not C, CM, CD, CV) : offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
tim-10	error	Dosage.timing.repeat	If there's a timeOfDay, there cannot be a when, or vice versa : timeOfDay.empty() or when.empty()

This structure is derived from Dosage

Summary

Maturity: 0

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Dosage		0..*	Dosage	How the medication is/was taken or should be taken
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
route	OΣ	0..1	CodeableConcept	How drug should enter body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. Obligations Actor SHOULD:populate-if-known HdrCreator-L2 SHOULD:display HdrConsumer-L2 SHOULD:populate-if-known HdrCreator-L3 SHOULD:display HdrConsumer-L3
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Dosage.route	example	SNOMEDCTRouteCodes http://hl7.org/fhir/ValueSet/route-codes|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Differential View

This structure is derived from Dosage

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Dosage		0..*	Dosage	How the medication is/was taken or should be taken
timing
repeat
duration	O	0..1	decimal	How long when it happens Obligations Actor SHALL:able-to-populate HdrCreator-L2 SHALL:display HdrConsumer-L2 SHALL:able-to-populate HdrCreator-L3 SHALL:display HdrConsumer-L3
route	O	0..1	CodeableConcept	How drug should enter body Obligations Actor SHOULD:populate-if-known HdrCreator-L2 SHOULD:display HdrConsumer-L2 SHOULD:populate-if-known HdrCreator-L3 SHOULD:display HdrConsumer-L3
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Dosage		0..*	Dosage	How the medication is/was taken or should be taken
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
sequence	Σ	0..1	integer	The order of the dosage instructions
text	Σ	0..1	string	Free text dosage instructions e.g. SIG
additionalInstruction	Σ	0..*	CodeableConcept	Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".
patientInstruction	Σ	0..1	string	Patient or consumer oriented instructions
timing	Σ	0..1	Timing	When medication should be administered
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
event	Σ	0..*	dateTime	When the event occurs
repeat	ΣC	0..1	Element	When the event is to occur Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
bounds[x]	Σ	0..1		Length/Range of lengths, or (Start and/or end) limits
boundsDuration			Duration
boundsRange			Range
boundsPeriod			Period
count	Σ	0..1	positiveInt	Number of times to repeat
countMax	Σ	0..1	positiveInt	Maximum number of times to repeat
duration	OΣ	0..1	decimal	How long when it happens Obligations Actor SHALL:able-to-populate HdrCreator-L2 SHALL:display HdrConsumer-L2 SHALL:able-to-populate HdrCreator-L3 SHALL:display HdrConsumer-L3
durationMax	Σ	0..1	decimal	How long when it happens (Max)
durationUnit	Σ	0..1	code	s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM).
frequency	Σ	0..1	positiveInt	Event occurs frequency times per period
frequencyMax	Σ	0..1	positiveInt	Event occurs up to frequencyMax times per period
period	Σ	0..1	decimal	Event occurs frequency times per period
periodMax	Σ	0..1	decimal	Upper limit of period (3-4 hours)
periodUnit	Σ	0..1	code	s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM).
dayOfWeek	Σ	0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required)
timeOfDay	Σ	0..*	time	Time of day for action
when	Σ	0..*	code	Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule.
offset	Σ	0..1	unsignedInt	Minutes from event (before or after)
code	Σ	0..1	CodeableConcept	BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.
asNeeded[x]	Σ	0..1		Take "as needed" (for x) Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.
asNeededBoolean			boolean
asNeededCodeableConcept			CodeableConcept
site	Σ	0..1	CodeableConcept	Body site to administer to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.
route	OΣ	0..1	CodeableConcept	How drug should enter body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. Obligations Actor SHOULD:populate-if-known HdrCreator-L2 SHOULD:display HdrConsumer-L2 SHOULD:populate-if-known HdrCreator-L3 SHOULD:display HdrConsumer-L3
method	Σ	0..1	CodeableConcept	Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
doseAndRate	Σ	0..*	Element	Amount of medication administered
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
type	Σ	0..1	CodeableConcept	The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified.
dose[x]	Σ	0..1		Amount of medication per dose
doseRange			Range
doseQuantity			Quantity(SimpleQuantity)
rate[x]	Σ	0..1		Amount of medication per unit of time
rateRatio			Ratio
rateRange			Range
rateQuantity			Quantity(SimpleQuantity)
maxDosePerPeriod	Σ	0..1	Ratio	Upper limit on medication per unit of time
maxDosePerAdministration	Σ	0..1	SimpleQuantity(4.0.1)	Upper limit on medication per administration
maxDosePerLifetime	Σ	0..1	SimpleQuantity(4.0.1)	Upper limit on medication per lifetime of the patient
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Dosage.additionalInstruction	example	SNOMEDCTAdditionalDosageInstructions http://hl7.org/fhir/ValueSet/additional-instruction-codes|4.0.1 From the FHIR Standard
Dosage.timing.repeat.durationUnit	required	UnitsOfTime http://hl7.org/fhir/ValueSet/units-of-time|4.0.1 From the FHIR Standard
Dosage.timing.repeat.periodUnit	required	UnitsOfTime http://hl7.org/fhir/ValueSet/units-of-time|4.0.1 From the FHIR Standard
Dosage.timing.repeat.dayOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 From the FHIR Standard
Dosage.timing.repeat.when	required	EventTiming http://hl7.org/fhir/ValueSet/event-timing|4.0.1 From the FHIR Standard
Dosage.timing.code	preferred	TimingAbbreviation http://hl7.org/fhir/ValueSet/timing-abbreviation|4.0.1 From the FHIR Standard
Dosage.asNeeded[x]	example	SNOMEDCTMedicationAsNeededReasonCodes http://hl7.org/fhir/ValueSet/medication-as-needed-reason|4.0.1 From the FHIR Standard
Dosage.site	example	SNOMEDCTAnatomicalStructureForAdministrationSiteCodes http://hl7.org/fhir/ValueSet/approach-site-codes|4.0.1 From the FHIR Standard
Dosage.route	example	SNOMEDCTRouteCodes http://hl7.org/fhir/ValueSet/route-codes|4.0.1 From the FHIR Standard
Dosage.method	example	SNOMEDCTAdministrationMethodCodes http://hl7.org/fhir/ValueSet/administration-method-codes|4.0.1 From the FHIR Standard
Dosage.doseAndRate.type	example	DoseAndRateType http://hl7.org/fhir/ValueSet/dose-rate-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()
tim-1	error	Dosage.timing.repeat	if there's a duration, there needs to be duration units : duration.empty() or durationUnit.exists()
tim-2	error	Dosage.timing.repeat	if there's a period, there needs to be period units : period.empty() or periodUnit.exists()
tim-4	error	Dosage.timing.repeat	duration SHALL be a non-negative value : duration.exists() implies duration >= 0
tim-5	error	Dosage.timing.repeat	period SHALL be a non-negative value : period.exists() implies period >= 0
tim-6	error	Dosage.timing.repeat	If there's a periodMax, there must be a period : periodMax.empty() or period.exists()
tim-7	error	Dosage.timing.repeat	If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists()
tim-8	error	Dosage.timing.repeat	If there's a countMax, there must be a count : countMax.empty() or count.exists()
tim-9	error	Dosage.timing.repeat	If there's an offset, there must be a when (and not C, CM, CD, CV) : offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
tim-10	error	Dosage.timing.repeat	If there's a timeOfDay, there cannot be a when, or vice versa : timeOfDay.empty() or when.empty()

This structure is derived from Dosage

Summary

Maturity: 0

Other representations of profile: CSV, Excel, Schematron