Finnish Base Profiles
0.3.0 - ci-build Finland flag

Finnish Base Profiles - Local Development build (v0.3.0). See the Directory of published versions

Resource Profile: fiphr-sd-insulindosing-r4

Official URL: http://phr.kanta.fi/StructureDefinition/fiphr-sd-insulindosing-r4 Version: 0.3.0
Draft as of 2020-10-16 Computable Name: FIPHRSDInsulinDosageR4

Finnish PHR profile for Insulin Dosing

Finnish PHR profile for the administered insulin doses of a patient.

Usage:

Formal Views of Profile Content

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

This structure is derived from MedicationAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..*MedicationAdministrationAdministration of medication to a patient
... meta 1..1MetaMetadata about the resource
.... Slices for profile 1..*canonical(StructureDefinition)Profiles this resource claims to conform to
Slice: Unordered, Open by value:$this
..... profile:fiphrProfile 1..1canonical(StructureDefinition)Profiles this resource claims to conform to
Fixed Value: http://phr.kanta.fi/StructureDefinition/fiphr-sd-insulindosing-r4
... language 1..1codeLanguage of the resource content
Binding: CommonLanguages (required): A code of human language.

... text 1..1NarrativeText summary of the resource, for human interpretation
... creatingApplication 0..*(Complex)Application identification
URL: http://phr.kanta.fi/StructureDefinition/fiphr-ext-creatingapplication
... identifier 1..*IdentifierBusiness Identifier for the resource
.... use 0..1codeusual | official | temp | secondary | old (If known)
.... system 1..1uriThe namespace for the identifier value
.... value 1..1stringThe value that is unique
.... assigner 0..0
... instantiates 0..0
... partOf 0..0
... status 1..1codeTo show that the administration has been completed.
Fixed Value: completed
... statusReason 0..0
... category 0..0
... Slices for medication[x] 1..1CodeableConcept, Reference(Medication)What was administered
Slice: Unordered, Open by type:$this
.... medication[x]:medicationCodeableConcept 1..1CodeableConceptFinnish PHR: Identifies the medication that was administered
Binding: Value Set Finnish PHR Insulin Code (extensible): Codes identifying substance or product administered.

..... Slices for coding 1..*CodingIn Finnish PHR either VNRCode or insulinCode SHALL be used. Other codes are optional.
Slice: Unordered, Open by value:system
...... coding:VNRCode 0..1CodingFinnish PHR: VNR code of the medication
....... system 1..1uriFinnish PHR: VNR code system
Fixed Value: urn:oid:1.2.246.537.6.55
....... code 1..1codeFinnish PHR: VNR code defined by VNR code system
....... display 1..1stringRepresentation defined by the system
...... coding:insulinCode 0..1CodingFinnish PHR: A code indicating the type of insulin
....... system 1..1uriFinnish PHR: Code system for insulin codes
Fixed Value: http://phr.kanta.fi/CodeSystem/fiphr-cs-insulincode
....... code 1..1codeFinnish PHR: A code of the medication
....... display 1..1stringRepresentation defined by the system
..... text 1..1stringPlain text representation of the concept
... subject 1..1Reference(Finnish PHR Patient profile) {r}Who received medication
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... context 0..0
... supportingInformation 0..0
... effective[x] 1..1dateTime, PeriodFinnish PHR: Time of administration
... performer
.... actor 1..1Reference(Finnish PHR Patient profile) {r}Who performed the medication administration
..... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... reasonCode 0..0
... reasonReference 0..0
... request 0..0
... device 0..0
... note
.... author[x] 0..1Individual responsible for the annotation
..... authorReferenceReference(Finnish PHR Patient profile)
..... authorStringstring
... dosage
.... site
..... Slices for coding 1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:fiphrCoding 1..1CodingCode defined by a terminology system
Binding: http://phr.kanta.fi/ValueSet/fiphr-vs-dosagesite (required): A value set for the site location the medicine enters into or onto the body (Reference to the national AR/Lääkitys - Lääkkeenantopaikka code system.)

....... system 1..1uriIdentity of the terminology system
Fixed Value: urn:oid:1.2.246.537.5.163
....... code 1..1codeSymbol in syntax defined by the system
....... display 1..1stringRepresentation defined by the system
... eventHistory 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
MedicationAdministration.languagerequiredCommonLanguages
MedicationAdministration.medication[x]:medicationCodeableConceptextensiblefiphr-vs-insulincode
MedicationAdministration.dosage.site.coding:fiphrCodingrequiredhttp://phr.kanta.fi/ValueSet/fiphr-vs-dosagesite
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..*MedicationAdministrationAdministration of medication to a patient
... meta Σ1..1MetaMetadata about the resource
.... Slices for profile Σ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
Slice: Unordered, Open by value:$this
..... profile:fiphrProfile Σ1..1canonical(StructureDefinition)Profiles this resource claims to conform to

Fixed Value: http://phr.kanta.fi/StructureDefinition/fiphr-sd-insulindosing-r4
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 1..1codeLanguage of the resource content
Binding: CommonLanguages (required): A code of human language.

... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... creatingApplication 0..*(Complex)Application identification
URL: http://phr.kanta.fi/StructureDefinition/fiphr-ext-creatingapplication
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 1..*IdentifierBusiness Identifier for the resource
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
... status ?!Σ1..1codeTo show that the administration has been completed.
Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration.


Fixed Value: completed
... Slices for medication[x] Σ1..1What was administered
Slice: Unordered, Open by type:$this
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept Σ1..1CodeableConceptFinnish PHR: Identifies the medication that was administered
Binding: Value Set Finnish PHR Insulin Code (extensible): Codes identifying substance or product administered.

..... Slices for coding Σ1..*CodingIn Finnish PHR either VNRCode or insulinCode SHALL be used. Other codes are optional.
Slice: Unordered, Open by value:system
...... coding:VNRCode Σ0..1CodingFinnish PHR: VNR code of the medication
....... system Σ1..1uriFinnish PHR: VNR code system
Fixed Value: urn:oid:1.2.246.537.6.55
....... code Σ1..1codeFinnish PHR: VNR code defined by VNR code system
....... display Σ1..1stringRepresentation defined by the system
...... coding:insulinCode Σ0..1CodingFinnish PHR: A code indicating the type of insulin
....... system Σ1..1uriFinnish PHR: Code system for insulin codes
Fixed Value: http://phr.kanta.fi/CodeSystem/fiphr-cs-insulincode
....... code Σ1..1codeFinnish PHR: A code of the medication
....... display Σ1..1stringRepresentation defined by the system
..... text Σ1..1stringPlain text representation of the concept
... subject Σ1..1Reference(Finnish PHR Patient profile) {r}Who received medication
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... effective[x] Σ1..1Finnish PHR: Time of administration
.... effectiveDateTimedateTime
.... effectivePeriodPeriod

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
MedicationAdministration.languagerequiredCommonLanguages
MedicationAdministration.identifier.userequiredIdentifierUse
MedicationAdministration.statusrequiredFixed Value: completed
MedicationAdministration.medication[x]exampleSNOMEDCTMedicationCodes
MedicationAdministration.medication[x]:medicationCodeableConceptextensiblefiphr-vs-insulincode

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationAdministrationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationAdministrationIf 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-4errorMedicationAdministrationIf 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-5errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationAdministrationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..*MedicationAdministrationAdministration of medication to a patient
... id Σ0..1idLogical id of this artifact
... meta Σ1..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... Slices for profile Σ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
Slice: Unordered, Open by value:$this
..... profile:fiphrProfile Σ1..1canonical(StructureDefinition)Profiles this resource claims to conform to

Fixed Value: http://phr.kanta.fi/StructureDefinition/fiphr-sd-insulindosing-r4
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 1..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... creatingApplication 0..*(Complex)Application identification
URL: http://phr.kanta.fi/StructureDefinition/fiphr-ext-creatingapplication
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 1..*IdentifierBusiness Identifier for the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
... status ?!Σ1..1codeTo show that the administration has been completed.
Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration.


Fixed Value: completed
... Slices for medication[x] Σ1..1What was administered
Slice: Unordered, Open by type:$this
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept Σ1..1CodeableConceptFinnish PHR: Identifies the medication that was administered
Binding: Value Set Finnish PHR Insulin Code (extensible): Codes identifying substance or product administered.

..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ1..*CodingIn Finnish PHR either VNRCode or insulinCode SHALL be used. Other codes are optional.
Slice: Unordered, Open by value:system
...... coding:VNRCode Σ0..1CodingFinnish PHR: VNR code of the medication
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriFinnish PHR: VNR code system
Fixed Value: urn:oid:1.2.246.537.6.55
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeFinnish PHR: VNR code defined by VNR code system
....... display Σ1..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... coding:insulinCode Σ0..1CodingFinnish PHR: A code indicating the type of insulin
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriFinnish PHR: Code system for insulin codes
Fixed Value: http://phr.kanta.fi/CodeSystem/fiphr-cs-insulincode
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeFinnish PHR: A code of the medication
....... display Σ1..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ1..1stringPlain text representation of the concept
... subject Σ1..1Reference(Finnish PHR Patient profile) {r}Who received medication
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... effective[x] Σ1..1Finnish PHR: Time of administration
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... performer Σ0..*BackboneElementWho performed the medication administration and what they did
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function 0..1CodeableConceptType of performance
Binding: MedicationAdministration Performer Function Codes (example): A code describing the role an individual played in administering the medication.

.... actor Σ1..1Reference(Finnish PHR Patient profile) {r}Who performed the medication administration
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
..... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ0..1stringText alternative for the resource
... note 0..*AnnotationInformation about the administration
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(Finnish PHR Patient profile)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text Σ1..1markdownThe annotation - text content (as markdown)
... dosage C0..1BackboneElementDetails of how medication was taken
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... text 0..1stringFree text dosage instructions e.g. SIG
.... site 0..1CodeableConceptBody site administered to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.

..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:fiphrCoding Σ1..1CodingCode defined by a terminology system
Binding: http://phr.kanta.fi/ValueSet/fiphr-vs-dosagesite (required): A value set for the site location the medicine enters into or onto the body (Reference to the national AR/Lääkitys - Lääkkeenantopaikka code system.)


....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: urn:oid:1.2.246.537.5.163
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeSymbol in syntax defined by the system
....... display Σ1..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... route 0..1CodeableConceptPath of substance into 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.

.... method 0..1CodeableConceptHow drug was administered
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.

.... dose 0..1SimpleQuantityAmount of medication per dose
.... rate[x] 0..1Dose quantity per unit of time
..... rateRatioRatio
..... rateQuantityQuantity(SimpleQuantity)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
MedicationAdministration.meta.securityextensibleAll Security Labels
MedicationAdministration.meta.tagexampleCommonTags
MedicationAdministration.languagerequiredCommonLanguages
MedicationAdministration.identifier.userequiredIdentifierUse
MedicationAdministration.identifier.typeextensibleIdentifier Type Codes
MedicationAdministration.statusrequiredFixed Value: completed
MedicationAdministration.medication[x]exampleSNOMEDCTMedicationCodes
MedicationAdministration.medication[x]:medicationCodeableConceptextensiblefiphr-vs-insulincode
MedicationAdministration.subject.typeextensibleResourceType
MedicationAdministration.performer.functionexampleMedicationAdministration Performer Function Codes
MedicationAdministration.performer.actor.typeextensibleResourceType
MedicationAdministration.dosage.siteexampleSNOMEDCTAnatomicalStructureForAdministrationSiteCodes
MedicationAdministration.dosage.site.coding:fiphrCodingrequiredhttp://phr.kanta.fi/ValueSet/fiphr-vs-dosagesite
MedicationAdministration.dosage.routeexampleSNOMEDCTRouteCodes
MedicationAdministration.dosage.methodexampleSNOMEDCTAdministrationMethodCodes

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mad-1errorMedicationAdministration.dosageSHALL have at least one of dosage.dose or dosage.rate[x]
: dose.exists() or rate.exists()

This structure is derived from MedicationAdministration

Summary

Mandatory: 11 elements (12 nested mandatory elements)
Fixed Value: 5 elements
Prohibited: 12 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element MedicationAdministration.meta.profile is sliced based on the value of value:$this
  • The element MedicationAdministration.medication[x] is sliced based on the value of type:$this
  • The element MedicationAdministration.medication[x].coding is sliced based on the value of value:system
  • The element MedicationAdministration.dosage.site.coding is sliced based on the value of value:system

Differential View

This structure is derived from MedicationAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..*MedicationAdministrationAdministration of medication to a patient
... meta 1..1MetaMetadata about the resource
.... Slices for profile 1..*canonical(StructureDefinition)Profiles this resource claims to conform to
Slice: Unordered, Open by value:$this
..... profile:fiphrProfile 1..1canonical(StructureDefinition)Profiles this resource claims to conform to
Fixed Value: http://phr.kanta.fi/StructureDefinition/fiphr-sd-insulindosing-r4
... language 1..1codeLanguage of the resource content
Binding: CommonLanguages (required): A code of human language.

... text 1..1NarrativeText summary of the resource, for human interpretation
... creatingApplication 0..*(Complex)Application identification
URL: http://phr.kanta.fi/StructureDefinition/fiphr-ext-creatingapplication
... identifier 1..*IdentifierBusiness Identifier for the resource
.... use 0..1codeusual | official | temp | secondary | old (If known)
.... system 1..1uriThe namespace for the identifier value
.... value 1..1stringThe value that is unique
.... assigner 0..0
... instantiates 0..0
... partOf 0..0
... status 1..1codeTo show that the administration has been completed.
Fixed Value: completed
... statusReason 0..0
... category 0..0
... Slices for medication[x] 1..1CodeableConcept, Reference(Medication)What was administered
Slice: Unordered, Open by type:$this
.... medication[x]:medicationCodeableConcept 1..1CodeableConceptFinnish PHR: Identifies the medication that was administered
Binding: Value Set Finnish PHR Insulin Code (extensible): Codes identifying substance or product administered.

..... Slices for coding 1..*CodingIn Finnish PHR either VNRCode or insulinCode SHALL be used. Other codes are optional.
Slice: Unordered, Open by value:system
...... coding:VNRCode 0..1CodingFinnish PHR: VNR code of the medication
....... system 1..1uriFinnish PHR: VNR code system
Fixed Value: urn:oid:1.2.246.537.6.55
....... code 1..1codeFinnish PHR: VNR code defined by VNR code system
....... display 1..1stringRepresentation defined by the system
...... coding:insulinCode 0..1CodingFinnish PHR: A code indicating the type of insulin
....... system 1..1uriFinnish PHR: Code system for insulin codes
Fixed Value: http://phr.kanta.fi/CodeSystem/fiphr-cs-insulincode
....... code 1..1codeFinnish PHR: A code of the medication
....... display 1..1stringRepresentation defined by the system
..... text 1..1stringPlain text representation of the concept
... subject 1..1Reference(Finnish PHR Patient profile) {r}Who received medication
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... context 0..0
... supportingInformation 0..0
... effective[x] 1..1dateTime, PeriodFinnish PHR: Time of administration
... performer
.... actor 1..1Reference(Finnish PHR Patient profile) {r}Who performed the medication administration
..... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... reasonCode 0..0
... reasonReference 0..0
... request 0..0
... device 0..0
... note
.... author[x] 0..1Individual responsible for the annotation
..... authorReferenceReference(Finnish PHR Patient profile)
..... authorStringstring
... dosage
.... site
..... Slices for coding 1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:fiphrCoding 1..1CodingCode defined by a terminology system
Binding: http://phr.kanta.fi/ValueSet/fiphr-vs-dosagesite (required): A value set for the site location the medicine enters into or onto the body (Reference to the national AR/Lääkitys - Lääkkeenantopaikka code system.)

....... system 1..1uriIdentity of the terminology system
Fixed Value: urn:oid:1.2.246.537.5.163
....... code 1..1codeSymbol in syntax defined by the system
....... display 1..1stringRepresentation defined by the system
... eventHistory 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
MedicationAdministration.languagerequiredCommonLanguages
MedicationAdministration.medication[x]:medicationCodeableConceptextensiblefiphr-vs-insulincode
MedicationAdministration.dosage.site.coding:fiphrCodingrequiredhttp://phr.kanta.fi/ValueSet/fiphr-vs-dosagesite

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..*MedicationAdministrationAdministration of medication to a patient
... meta Σ1..1MetaMetadata about the resource
.... Slices for profile Σ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
Slice: Unordered, Open by value:$this
..... profile:fiphrProfile Σ1..1canonical(StructureDefinition)Profiles this resource claims to conform to

Fixed Value: http://phr.kanta.fi/StructureDefinition/fiphr-sd-insulindosing-r4
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 1..1codeLanguage of the resource content
Binding: CommonLanguages (required): A code of human language.

... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... creatingApplication 0..*(Complex)Application identification
URL: http://phr.kanta.fi/StructureDefinition/fiphr-ext-creatingapplication
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 1..*IdentifierBusiness Identifier for the resource
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
... status ?!Σ1..1codeTo show that the administration has been completed.
Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration.


Fixed Value: completed
... Slices for medication[x] Σ1..1What was administered
Slice: Unordered, Open by type:$this
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept Σ1..1CodeableConceptFinnish PHR: Identifies the medication that was administered
Binding: Value Set Finnish PHR Insulin Code (extensible): Codes identifying substance or product administered.

..... Slices for coding Σ1..*CodingIn Finnish PHR either VNRCode or insulinCode SHALL be used. Other codes are optional.
Slice: Unordered, Open by value:system
...... coding:VNRCode Σ0..1CodingFinnish PHR: VNR code of the medication
....... system Σ1..1uriFinnish PHR: VNR code system
Fixed Value: urn:oid:1.2.246.537.6.55
....... code Σ1..1codeFinnish PHR: VNR code defined by VNR code system
....... display Σ1..1stringRepresentation defined by the system
...... coding:insulinCode Σ0..1CodingFinnish PHR: A code indicating the type of insulin
....... system Σ1..1uriFinnish PHR: Code system for insulin codes
Fixed Value: http://phr.kanta.fi/CodeSystem/fiphr-cs-insulincode
....... code Σ1..1codeFinnish PHR: A code of the medication
....... display Σ1..1stringRepresentation defined by the system
..... text Σ1..1stringPlain text representation of the concept
... subject Σ1..1Reference(Finnish PHR Patient profile) {r}Who received medication
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... effective[x] Σ1..1Finnish PHR: Time of administration
.... effectiveDateTimedateTime
.... effectivePeriodPeriod

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
MedicationAdministration.languagerequiredCommonLanguages
MedicationAdministration.identifier.userequiredIdentifierUse
MedicationAdministration.statusrequiredFixed Value: completed
MedicationAdministration.medication[x]exampleSNOMEDCTMedicationCodes
MedicationAdministration.medication[x]:medicationCodeableConceptextensiblefiphr-vs-insulincode

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationAdministrationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationAdministrationIf 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-4errorMedicationAdministrationIf 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-5errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationAdministrationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..*MedicationAdministrationAdministration of medication to a patient
... id Σ0..1idLogical id of this artifact
... meta Σ1..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... Slices for profile Σ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
Slice: Unordered, Open by value:$this
..... profile:fiphrProfile Σ1..1canonical(StructureDefinition)Profiles this resource claims to conform to

Fixed Value: http://phr.kanta.fi/StructureDefinition/fiphr-sd-insulindosing-r4
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 1..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... creatingApplication 0..*(Complex)Application identification
URL: http://phr.kanta.fi/StructureDefinition/fiphr-ext-creatingapplication
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 1..*IdentifierBusiness Identifier for the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
... status ?!Σ1..1codeTo show that the administration has been completed.
Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration.


Fixed Value: completed
... Slices for medication[x] Σ1..1What was administered
Slice: Unordered, Open by type:$this
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept Σ1..1CodeableConceptFinnish PHR: Identifies the medication that was administered
Binding: Value Set Finnish PHR Insulin Code (extensible): Codes identifying substance or product administered.

..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ1..*CodingIn Finnish PHR either VNRCode or insulinCode SHALL be used. Other codes are optional.
Slice: Unordered, Open by value:system
...... coding:VNRCode Σ0..1CodingFinnish PHR: VNR code of the medication
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriFinnish PHR: VNR code system
Fixed Value: urn:oid:1.2.246.537.6.55
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeFinnish PHR: VNR code defined by VNR code system
....... display Σ1..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... coding:insulinCode Σ0..1CodingFinnish PHR: A code indicating the type of insulin
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriFinnish PHR: Code system for insulin codes
Fixed Value: http://phr.kanta.fi/CodeSystem/fiphr-cs-insulincode
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeFinnish PHR: A code of the medication
....... display Σ1..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ1..1stringPlain text representation of the concept
... subject Σ1..1Reference(Finnish PHR Patient profile) {r}Who received medication
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... effective[x] Σ1..1Finnish PHR: Time of administration
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... performer Σ0..*BackboneElementWho performed the medication administration and what they did
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function 0..1CodeableConceptType of performance
Binding: MedicationAdministration Performer Function Codes (example): A code describing the role an individual played in administering the medication.

.... actor Σ1..1Reference(Finnish PHR Patient profile) {r}Who performed the medication administration
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
..... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ0..1stringText alternative for the resource
... note 0..*AnnotationInformation about the administration
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(Finnish PHR Patient profile)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text Σ1..1markdownThe annotation - text content (as markdown)
... dosage C0..1BackboneElementDetails of how medication was taken
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... text 0..1stringFree text dosage instructions e.g. SIG
.... site 0..1CodeableConceptBody site administered to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.

..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:fiphrCoding Σ1..1CodingCode defined by a terminology system
Binding: http://phr.kanta.fi/ValueSet/fiphr-vs-dosagesite (required): A value set for the site location the medicine enters into or onto the body (Reference to the national AR/Lääkitys - Lääkkeenantopaikka code system.)


....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: urn:oid:1.2.246.537.5.163
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeSymbol in syntax defined by the system
....... display Σ1..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... route 0..1CodeableConceptPath of substance into 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.

.... method 0..1CodeableConceptHow drug was administered
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.

.... dose 0..1SimpleQuantityAmount of medication per dose
.... rate[x] 0..1Dose quantity per unit of time
..... rateRatioRatio
..... rateQuantityQuantity(SimpleQuantity)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
MedicationAdministration.meta.securityextensibleAll Security Labels
MedicationAdministration.meta.tagexampleCommonTags
MedicationAdministration.languagerequiredCommonLanguages
MedicationAdministration.identifier.userequiredIdentifierUse
MedicationAdministration.identifier.typeextensibleIdentifier Type Codes
MedicationAdministration.statusrequiredFixed Value: completed
MedicationAdministration.medication[x]exampleSNOMEDCTMedicationCodes
MedicationAdministration.medication[x]:medicationCodeableConceptextensiblefiphr-vs-insulincode
MedicationAdministration.subject.typeextensibleResourceType
MedicationAdministration.performer.functionexampleMedicationAdministration Performer Function Codes
MedicationAdministration.performer.actor.typeextensibleResourceType
MedicationAdministration.dosage.siteexampleSNOMEDCTAnatomicalStructureForAdministrationSiteCodes
MedicationAdministration.dosage.site.coding:fiphrCodingrequiredhttp://phr.kanta.fi/ValueSet/fiphr-vs-dosagesite
MedicationAdministration.dosage.routeexampleSNOMEDCTRouteCodes
MedicationAdministration.dosage.methodexampleSNOMEDCTAdministrationMethodCodes

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mad-1errorMedicationAdministration.dosageSHALL have at least one of dosage.dose or dosage.rate[x]
: dose.exists() or rate.exists()

This structure is derived from MedicationAdministration

Summary

Mandatory: 11 elements (12 nested mandatory elements)
Fixed Value: 5 elements
Prohibited: 12 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element MedicationAdministration.meta.profile is sliced based on the value of value:$this
  • The element MedicationAdministration.medication[x] is sliced based on the value of type:$this
  • The element MedicationAdministration.medication[x].coding is sliced based on the value of value:system
  • The element MedicationAdministration.dosage.site.coding is sliced based on the value of value:system

 

Other representations of profile: CSV, Excel, Schematron