Iron Supplement - WHO Antenatal Care Guideline Implementation Guide v0.3.0

WHO Antenatal Care Guideline Implementation Guide, published by World Health Organization (WHO). This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/costateixeira/smart-anc/ and changes regularly. See the Directory of published versions

Resource Profile: Iron Supplement

Official URL: http://fhir.org/guides/who/anc-cds/StructureDefinition/iron-supplement				Version: 0.3.0
Draft as of 2024-09-10				Computable Name: IronSupplement
Usage:Workflow Task: Nutrition supplementation

Iron Supplement

Usage:

Examples for this Resource Profile: MedicationRequest/iron-supplement-example

Formal Views of Profile Content

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

Differential Table
Key Elements Table
Snapshot Table
Statistics/References
All

This structure is derived from ANCMedicationRequest

Name	Flags	Card.	Type	Description & Constraints
MedicationRequest		0..*	ANCMedicationRequest	Ordering of medication for patient or group
dosageInstruction		0..*	Dosage	How the medication should be taken
timing		0..1	Timing	When medication should be administered
repeat		0..1	Element	When the event is to occur
periodUnit	S	0..1	code	Type of iron supplement dosage provided Binding: Type of iron supplement dosage provided Choices (required)
doseAndRate		0..*	Element	Amount of medication administered
dose[x]	S	1..1	Quantity	Amount of iron prescribed
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
MedicationRequest.dosageInstruction.timing.repeat.periodUnit	required	TypeofironsupplementdosageprovidedChoices `http://fhir.org/guides/who/anc-cds/ValueSet/anc-b10-de93` from this IG

Name	Flags	Card.	Type	Description & Constraints
MedicationRequest		0..*	ANCMedicationRequest	Ordering of medication for patient or group
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
rationale	S	0..1	markdown	Explanation URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	S	1..*	Identifier	External ids for this request
use	?!SΣ	1..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
status	?!SΣ	1..1	code	active \| on-hold \| cancelled \| completed \| entered-in-error \| stopped \| draft \| unknown Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.
intent	?!SΣ	1..1	code	proposal \| plan \| order \| original-order \| reflex-order \| filler-order \| instance-order \| option Binding: medicationRequest Intent (required): The kind of medication order.
category	S	0..*	CodeableConcept	Type of medication usage Binding: medicationRequest Category Codes (preferred): Type of medication usage
priority	SΣ	0..1	code	routine \| urgent \| asap \| stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
doNotPerform	?!SΣ	0..1	boolean	True if request is prohibiting action Fixed Value: false
medication[x]	SΣ	1..1		Medication to be taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
medicationCodeableConcept			CodeableConcept
medicationReference			Reference(Medication)
subject	SΣ	1..1	Reference(ANC Patient)	Who or group medication request is for
encounter	S	0..1	Reference(ANC Encounter)	Encounter created as part of encounter/admission/stay
supportingInformation	S	0..*	Reference(Resource)	Pertinent information
authoredOn	SΣ	1..1	dateTime	When request was initially authored
requester	SΣ	0..1	Reference(ANC Practitioner \| ANC PractitionerRole \| ANC Patient \| ANC RelatedPerson)	Who/What requested the Request
recorder	S	0..1	Reference(ANC Practitioner \| ANC PractitionerRole)	Person who entered the request
reasonCode	S	0..*	CodeableConcept	Reason or indication for ordering or not ordering the medication Binding: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered.
instantiatesCanonical	SΣ	0..*	canonical()	Source
dosageInstruction	S	0..*	Dosage	How the medication should be taken
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
timing	SΣ	0..1	Timing	When medication should be administered
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
repeat	SΣC	0..1	Element	When the event is to occur tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa
frequency	SΣ	0..1	positiveInt	Event occurs frequency times per period
frequencyMax	SΣ	0..1	positiveInt	Event occurs up to frequencyMax times per period
period	SΣ	0..1	decimal	Event occurs frequency times per period
periodMax	SΣ	0..1	decimal	Upper limit of period (3-4 hours)
periodUnit	SΣ	0..1	code	Type of iron supplement dosage provided Binding: Type of iron supplement dosage provided Choices (required)
asNeeded[x]	SΣ	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	SΣ	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	SΣ	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.
method	SΣ	0..1	CodeableConcept	Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
doseAndRate	SΣ	0..*	Element	Amount of medication administered
dose[x]	SΣ	1..1	Quantity	Amount of iron prescribed
dispenseRequest	S	0..1	BackboneElement	Medication supply authorization
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
dispenseInterval	S	0..1	Duration	Minimum period of time between dispenses
validityPeriod	S	0..1	Period	Time period supply is authorized for
numberOfRepeatsAllowed	S	0..1	unsignedInt	Number of refills authorized
quantity	S	0..1	SimpleQuantity	Amount of medication to supply per dispense
expectedSupplyDuration	S	0..1	Duration	Number of days supply per dispense
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
MedicationRequest.identifier.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.1` from the FHIR Standard
MedicationRequest.status	required	medicationrequest Status `http://hl7.org/fhir/ValueSet/medicationrequest-status\|4.0.1` from the FHIR Standard
MedicationRequest.intent	required	medicationRequest Intent `http://hl7.org/fhir/ValueSet/medicationrequest-intent\|4.0.1` from the FHIR Standard
MedicationRequest.category	preferred	medicationRequest Category Codes `http://hl7.org/fhir/ValueSet/medicationrequest-category` from the FHIR Standard
MedicationRequest.priority	required	RequestPriority `http://hl7.org/fhir/ValueSet/request-priority\|4.0.1` from the FHIR Standard
MedicationRequest.medication[x]	example	SNOMEDCTMedicationCodes `http://hl7.org/fhir/ValueSet/medication-codes` from the FHIR Standard
MedicationRequest.reasonCode	example	Condition/Problem/DiagnosisCodes `http://hl7.org/fhir/ValueSet/condition-code` from the FHIR Standard
MedicationRequest.dosageInstruction.timing.repeat.periodUnit	required	TypeofironsupplementdosageprovidedChoices `http://fhir.org/guides/who/anc-cds/ValueSet/anc-b10-de93` from this IG
MedicationRequest.dosageInstruction.asNeeded[x]	example	SNOMEDCTMedicationAsNeededReasonCodes `http://hl7.org/fhir/ValueSet/medication-as-needed-reason` from the FHIR Standard
MedicationRequest.dosageInstruction.site	example	SNOMEDCTAnatomicalStructureForAdministrationSiteCodes `http://hl7.org/fhir/ValueSet/approach-site-codes` from the FHIR Standard
MedicationRequest.dosageInstruction.route	example	SNOMEDCTRouteCodes `http://hl7.org/fhir/ValueSet/route-codes` from the FHIR Standard
MedicationRequest.dosageInstruction.method	example	SNOMEDCTAdministrationMethodCodes `http://hl7.org/fhir/ValueSet/administration-method-codes` from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	MedicationRequest	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	MedicationRequest	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	MedicationRequest	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	MedicationRequest	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	MedicationRequest	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
tim-1	error	MedicationRequest.dosageInstruction.timing.repeat	if there's a duration, there needs to be duration units : duration.empty() or durationUnit.exists()
tim-2	error	MedicationRequest.dosageInstruction.timing.repeat	if there's a period, there needs to be period units : period.empty() or periodUnit.exists()
tim-4	error	MedicationRequest.dosageInstruction.timing.repeat	duration SHALL be a non-negative value : duration.exists() implies duration >= 0
tim-5	error	MedicationRequest.dosageInstruction.timing.repeat	period SHALL be a non-negative value : period.exists() implies period >= 0
tim-6	error	MedicationRequest.dosageInstruction.timing.repeat	If there's a periodMax, there must be a period : periodMax.empty() or period.exists()
tim-7	error	MedicationRequest.dosageInstruction.timing.repeat	If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists()
tim-8	error	MedicationRequest.dosageInstruction.timing.repeat	If there's a countMax, there must be a count : countMax.empty() or count.exists()
tim-9	error	MedicationRequest.dosageInstruction.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	MedicationRequest.dosageInstruction.timing.repeat	If there's a timeOfDay, there cannot be a when, or vice versa : timeOfDay.empty() or when.empty()