Generated Narrative: StructureDefinition SHCPatchMedicationStatement Name Flags Card. Type Description & Constraints Parameters <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( shc-patch-medication-statement-01, shc-patch-medication-statement-02, shc-patch-medication-statement-03, shc-patch-medication-statement-04, shc-patch-medication-statement-05 )">C 0..* Parameters Parameters for patching MedicationStatement resource elements supported in Smart Health Checks Constraints: shc-patch-medication-statement-01, shc-patch-medication-statement-02, shc-patch-medication-statement-03, shc-patch-medication-statement-04, shc-patch-medication-statement-05 #xD; parameter SO 1..* BackboneElement Operation Parameter Obligations Actor SHALL:process SHC Host FHIR Server SHALL:populate SHC App #xD; name SO 1..1 string Name from the definition Fixed Value: operation Obligations Actor SHALL:process SHC Host FHIR Server SHALL:populate SHC App #xD; Slices for part 4..* Named part of a multi-part parameter Slice: Unordered, Open by value:name #xD; part:type SO 1..1 BackboneElement Patch operation to perform Obligations Actor SHALL:process SHC Host FHIR Server SHALL:populate SHC App #xD; name SO 1..1 string Name from the definition Fixed Value: type Obligations Actor SHALL:process SHC Host FHIR Server SHALL:populate SHC App #xD; value[x] SO 1..1 code If parameter is a data type Fixed Value: add Obligations Actor SHALL:process SHC Host FHIR Server SHALL:populate SHC App #xD; part:path SO 1..1 BackboneElement Where to perform the operation Obligations Actor SHALL:process SHC Host FHIR Server SHALL:populate SHC App #xD; name SO 1..1 string Name from the definition Fixed Value: path Obligations Actor SHALL:process SHC Host FHIR Server SHALL:populate SHC App #xD; value[x] SO 1..1 string If parameter is a data type Binding: Smart Health Checks Patch MedicationStatement Element Path (required) Obligations Actor SHALL:process SHC Host FHIR Server SHALL:populate SHC App #xD; part:name 1..1 BackboneElement Named part of a multi-part parameter #xD; name SO 1..1 string Name from the definition Fixed Value: name Obligations Actor SHALL:process SHC Host FHIR Server SHALL:populate SHC App #xD; value[x] SO 1..1 string If parameter is a data type Binding: Smart Health Checks Patch MedicationStatement Element Name (required) Obligations Actor SHALL:process SHC Host FHIR Server SHALL:populate SHC App #xD; part:value SO 1..1 BackboneElement Replacement value Obligations Actor SHALL:process SHC Host FHIR Server SHALL:populate SHC App #xD; name SO 1..1 string Name from the definition Fixed Value: value Obligations Actor SHALL:process SHC Host FHIR Server SHALL:populate SHC App #xD; Slices for value[x] SO<a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; font-style: italic; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; font-style: italic" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( shc-patch-medication-statement-01, shc-patch-medication-statement-02, shc-patch-medication-statement-03, shc-patch-medication-statement-04, shc-patch-medication-statement-05 )">C 1..1 If parameter is a data type Slice: Unordered, Open by type:$this Obligations Actor SHALL:process SHC Host FHIR Server SHALL:populate SHC App #xD; valueCode code #xD; valueMarkdown markdown #xD; valueString string #xD; valueAnnotation Annotation #xD; valueDosage Dosage #xD; value[x]:valueCode S 0..1 code If parameter is a data type Binding: Medication Statement Status Limited (required) #xD; value[x]:valueDosage SO 0..1 Dosage If parameter is a data type Obligations Actor SHALL:process SHC Host FHIR Server SHALL:populate-if-known SHC App #xD; text SO 1..1 string Free text dosage instructions e.g. SIG Obligations Actor SHALL:process SHC Host FHIR Server SHALL:populate-if-known SHC App #xD; value[x]:valueMarkdown SO 0..1 markdown If parameter is a data type Obligations Actor SHALL:process SHC Host FHIR Server SHALL:populate-if-known SHC App #xD; value[x]:valueAnnotation SO 0..1 Annotation If parameter is a data type Obligations Actor SHALL:process SHC Host FHIR Server SHALL:populate-if-known SHC App #xD; text SO 1..1 markdown The annotation - text content (as markdown) Obligations Actor SHALL:process SHC Host FHIR Server SHALL:populate-if-known SHC App #xD; part:pathLabel SO 0..1 BackboneElement Human readable representation of the path. Typically this is the relevant item text from the Questionnaire. Obligations Actor SHALL:populate SHC App #xD; name SO 1..1 string Name from the definition Fixed Value: pathLabel Obligations Actor SHALL:populate SHC App #xD; value[x] SO 1..1 string If parameter is a data type Obligations Actor SHALL:populate SHC App #xD; Documentation for this format
Smart Health Checks Patch MedicationStatement
This profile sets the expectations for a Parameters resource when used to patch MedicationStatement resources within Smart Health Checks.
Copyright © 2022+ Australian Government Department of Health and Aged Care - All rights reserved. This content is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License. See https://creativecommons.org/licenses/by-sa/4.0/.
Parameters for patching MedicationStatement resource elements supported in Smart Health Checks
This resource is a non-persisted resource used to pass information into and back from an [operation](http://hl7.org/fhir/R4/operations.html). It has no other use, and there is no RESTful endpoint associated with it.
The parameters that may be used are defined by the OperationDefinition resource.
When the part parameter named 'path' has a value of 'MedicationStatement' and the part parameter named 'name' has a value of 'status', the part parameter named 'value' SHALL have a value from the 'Medication Statement Status Limited' value set.
parameter.where(part.where(name='path').value = 'MedicationStatement' and part.where(name='name').value = 'status').exists() implies parameter.where(part.where(name='path').value = 'MedicationStatement' and part.where(name='name').value = 'status').part.where(name='value').value.memberOf('https://smartforms.csiro.au/ig/ValueSet/MedicationStatementStatusLimited')
When the part parameter named 'path' has a value of 'MedicationStatement' and the part parameter named 'name' has a value of 'dosage', the part parameter named 'value' SHALL have a value of type Dosage.
parameter.where(part.where(name='path').value = 'MedicationStatement' and part.where(name='name').value = 'dosage').exists() implies parameter.where(part.where(name='path').value = 'MedicationStatement' and part.where(name='name').value = 'dosage').part.where(name='value').value is Dosage
When the part parameter named 'path' has a value of 'MedicationStatement.dosage[0]' and the part parameter named 'name' has a value of 'text', the part parameter named 'value' SHALL have a value of type string.
parameter.where(part.where(name='path').value = 'MedicationStatement.dosage[0]' and part.where(name='name').value = 'text').exists() implies parameter.where(part.where(name='path').value = 'MedicationStatement.dosage[0]' and part.where(name='name').value = 'text').part.where(name='value').value is string
When the part parameter named 'path' has a value of 'MedicationStatement' and the part parameter named 'name' has a value of 'note', the part parameter named 'value' SHALL have a value of type Annotation.
parameter.where(part.where(name='path').value = 'MedicationStatement' and part.where(name='name').value = 'note').exists() implies parameter.where(part.where(name='path').value = 'MedicationStatement' and part.where(name='name').value = 'note').part.where(name='value').value is Annotation
When the part parameter named 'path' has a value of 'MedicationStatement.note[0]' and the part parameter named 'name' has a value of 'text', the part parameter named 'value' SHALL have a value of type markdown.
parameter.where(part.where(name='path').value = 'MedicationStatement.note[0]' and part.where(name='name').value = 'text').exists() implies parameter.where(part.where(name='path').value = 'MedicationStatement.note[0]' and part.where(name='name').value = 'text').part.where(name='value').value is markdown
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
A parameter passed to or received from the operation.
A parameter must have one and only one of (value, resource, part)
(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
(exists(f:resource) or exists(f:part) or exists(f:*[starts-with(local-name(.), 'value')])) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:resource))) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:part))) and not(exists(f:part) and exists(f:resource))
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Additional content defined by implementations
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
Extensions that cannot be ignored even if unrecognized
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
The name of the parameter (reference to the operation definition).
When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
Only one level of nested parameters is allowed.
Extensions are always sliced by (at least) url
Indicates the order in which the dosage instructions should be applied or interpreted.
If the sequence number of multiple Dosages is the same, then it is implied that the instructions are to be treated as concurrent. If the sequence number is different, then the Dosages are intended to be sequential.
Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. Additional information about administration or preparation of the medication should be included as text.
Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").
Information about administration or preparation of the medication (e.g. "infuse as rapidly as possibly via intraperitoneal port" or "immediately following drug x") should be populated in dosage.text.
Additional instruction is intended to be coded, but where no code exists, the element could include text. For example, "Swallow with plenty of water" which might or might not be coded.
A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".
Patient or consumer oriented instructions
Instructions in terms that are understood by the patient or consumer.
This attribute might not always be populated while the Dosage.text is expected to be populated. If both are populated, then the Dosage.text should reflect the content of the Dosage.timing.
The timing schedule for giving the medication to the patient. This data type allows many different expressions. For example: "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013". Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.
Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).
Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. Or you can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be True. If you set the Boolean to False, then the dose is given according to the schedule and is not "prn" or "as needed".
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.
.outboundRelationship[typeCode=PRCN].target[classCode=OBS, moodCode=EVN, code="as needed"].value=boolean or codable concept
If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension [bodySite](http://hl7.org/fhir/R4/extension-bodysite.html). May be a summary code, or a reference to a very precise definition of the location, or both.
A coded specification of the anatomic site where the medication first enters the body.
A coded concept describing the site location the medicine enters into or onto the body.
A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.
A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
Terminologies used often pre-coordinate this term with the route and or form of administration.
A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV.
A coded concept describing the technique by which the medicine is administered.
The kind of dose or rate specified, for example, ordered or calculated.
If the type is not populated, assume to be "ordered".
Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours.
The amount of therapeutic or other substance given at one administration event.
It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate. It is possible to specify a rate over time (for example, 100 ml/hour) using either the rateRatio and rateQuantity. The rateQuantity approach requires systems to have the capability to parse UCUM grammer where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour.
Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.
Upper limit on medication per unit of time
Upper limit on medication per unit of time.
This is intended for use as an adjunct to the dosage when there is an upper cap. For example "2 tablets every 4 hours to a maximum of 8/day".
The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours.
Upper limit on medication per administration
Upper limit on medication per administration.
This is intended for use as an adjunct to the dosage when there is an upper cap. For example, a body surface area related dose with a maximum amount, such as 1.5 mg/m2 (maximum 2 mg) IV over 5 – 10 minutes would have doseQuantity of 1.5 mg/m2 and maxDosePerAdministration of 2 mg.
The maximum total quantity of a therapeutic substance that may be administered to a subject per administration.
Upper limit on medication per lifetime of the patient
Upper limit on medication per lifetime of the patient.
The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject.
Individual responsible for the annotation
The individual responsible for making the annotation.
Organization is used when there's no need for specific attribution as to who made the comment.
Indicates when this particular annotation was made.
The annotation - text content (as markdown)
The text of the annotation in markdown format.
Human readable representation of the path. Typically this is the relevant item text from the Questionnaire.