WHO Family Planning Implementation Guide
0.2.0 - CI Build
WHO Family Planning Implementation Guide, published by World Health Organization (WHO). This guide is not an authorized publication; it is the continuous build for version 0.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-fp/ and changes regularly. See the Directory of published versions
| Official URL: http://fhir.org/guides/who/fp-cds/StructureDefinition/who-fp-medicationstatement-requested-contraceptive-method | Version: 0.2.0 | |||
| Draft as of 2026-11-19 | Computable Name: WHO-FP MedicationStatement (Requested Contraceptive Method) | |||
The first pick of method desired by the client, prior to medical eligibility tests. This may be the method in mind or the method selected after discussing the full range of methods.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | MedicationStatement | Method requested | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement. | |
![]() ![]() |
1..1 | CodeableConcept | What medication was taken Binding: http://hl7.org/fhir/who-int/core/ImplementationGuide/core/ValueSet/medicationbirthcontrolmethods-values (required) | |
![]() ![]() |
1..1 | Reference(Patient | Group) | Who is/was taking the medication | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationStatement.status | Base | required | Medication status codes | 📍4.0.1 | FHIR Std. |
| MedicationStatement.medication[x] | Base | required | http://hl7.org/fhir/who-int/core/ImplementationGuide/core/ValueSet/medicationbirthcontrolmethods-values | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | MedicationStatement | 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 | MedicationStatement | 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 | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | MedicationStatement | 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()
|
This structure is derived from MedicationStatement
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | MedicationStatement | Method requested | |
![]() ![]() |
1..1 | CodeableConcept | What medication was taken Binding: http://hl7.org/fhir/who-int/core/ImplementationGuide/core/ValueSet/medicationbirthcontrolmethods-values (required) | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationStatement.medication[x] | Base | required | http://hl7.org/fhir/who-int/core/ImplementationGuide/core/ValueSet/medicationbirthcontrolmethods-values | Not State | Unknown |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | MedicationStatement | Method requested | |||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..* | Identifier | External identifier | |||||
![]() ![]() |
0..* | Reference(MedicationRequest | CarePlan | ServiceRequest) | Fulfils plan, proposal or order | |||||
![]() ![]() |
0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) | Part of referenced event | |||||
![]() ![]() |
1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement. | |||||
![]() ![]() |
0..* | CodeableConcept | Reason for current status Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement. | |||||
![]() ![]() |
0..1 | CodeableConcept | Type of medication usage Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. | |||||
![]() ![]() |
1..1 | CodeableConcept | What medication was taken Binding: http://hl7.org/fhir/who-int/core/ImplementationGuide/core/ValueSet/medicationbirthcontrolmethods-values (required) | |||||
![]() ![]() |
1..1 | Reference(Patient | Group) | Who is/was taking the medication | |||||
![]() ![]() |
0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with MedicationStatement | |||||
![]() ![]() |
0..1 | The date/time or interval when the medication is/was/will be taken | ||||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() |
0..1 | dateTime | When the statement was asserted? | |||||
![]() ![]() |
0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Person or organization that provided the information about the taking of this medication | |||||
![]() ![]() |
0..* | Reference(Resource) | Additional supporting information | |||||
![]() ![]() |
0..* | CodeableConcept | Reason for why the medication is being/was taken Binding: Condition/Problem/DiagnosisCodes (example): A coded concept identifying why the medication is being taken. | |||||
![]() ![]() |
0..* | Reference(Condition | Observation | DiagnosticReport) | Condition or observation that supports why the medication is being/was taken | |||||
![]() ![]() |
0..* | Annotation | Further information about the statement | |||||
![]() ![]() |
0..* | Dosage | Details of how medication is/was taken or should be taken | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationStatement.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| MedicationStatement.status | Base | required | Medication status codes | 📍4.0.1 | FHIR Std. |
| MedicationStatement.statusReason | Base | example | SNOMED CT Drug Therapy Status codes | 📍4.0.1 | FHIR Std. |
| MedicationStatement.category | Base | preferred | Medication usage category codes | 📍4.0.1 | FHIR Std. |
| MedicationStatement.medication[x] | Base | required | http://hl7.org/fhir/who-int/core/ImplementationGuide/core/ValueSet/medicationbirthcontrolmethods-values | Not State | Unknown |
| MedicationStatement.reasonCode | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | MedicationStatement | 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 | MedicationStatement | 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 | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | MedicationStatement | 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()
|
This structure is derived from MedicationStatement
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | MedicationStatement | Method requested | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement. | |
![]() ![]() |
1..1 | CodeableConcept | What medication was taken Binding: http://hl7.org/fhir/who-int/core/ImplementationGuide/core/ValueSet/medicationbirthcontrolmethods-values (required) | |
![]() ![]() |
1..1 | Reference(Patient | Group) | Who is/was taking the medication | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationStatement.status | Base | required | Medication status codes | 📍4.0.1 | FHIR Std. |
| MedicationStatement.medication[x] | Base | required | http://hl7.org/fhir/who-int/core/ImplementationGuide/core/ValueSet/medicationbirthcontrolmethods-values | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | MedicationStatement | 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 | MedicationStatement | 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 | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | MedicationStatement | 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()
|
Differential View
This structure is derived from MedicationStatement
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | MedicationStatement | Method requested | |
![]() ![]() |
1..1 | CodeableConcept | What medication was taken Binding: http://hl7.org/fhir/who-int/core/ImplementationGuide/core/ValueSet/medicationbirthcontrolmethods-values (required) | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationStatement.medication[x] | Base | required | http://hl7.org/fhir/who-int/core/ImplementationGuide/core/ValueSet/medicationbirthcontrolmethods-values | Not State | Unknown |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | MedicationStatement | Method requested | |||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..* | Identifier | External identifier | |||||
![]() ![]() |
0..* | Reference(MedicationRequest | CarePlan | ServiceRequest) | Fulfils plan, proposal or order | |||||
![]() ![]() |
0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) | Part of referenced event | |||||
![]() ![]() |
1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement. | |||||
![]() ![]() |
0..* | CodeableConcept | Reason for current status Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement. | |||||
![]() ![]() |
0..1 | CodeableConcept | Type of medication usage Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. | |||||
![]() ![]() |
1..1 | CodeableConcept | What medication was taken Binding: http://hl7.org/fhir/who-int/core/ImplementationGuide/core/ValueSet/medicationbirthcontrolmethods-values (required) | |||||
![]() ![]() |
1..1 | Reference(Patient | Group) | Who is/was taking the medication | |||||
![]() ![]() |
0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with MedicationStatement | |||||
![]() ![]() |
0..1 | The date/time or interval when the medication is/was/will be taken | ||||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() |
0..1 | dateTime | When the statement was asserted? | |||||
![]() ![]() |
0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Person or organization that provided the information about the taking of this medication | |||||
![]() ![]() |
0..* | Reference(Resource) | Additional supporting information | |||||
![]() ![]() |
0..* | CodeableConcept | Reason for why the medication is being/was taken Binding: Condition/Problem/DiagnosisCodes (example): A coded concept identifying why the medication is being taken. | |||||
![]() ![]() |
0..* | Reference(Condition | Observation | DiagnosticReport) | Condition or observation that supports why the medication is being/was taken | |||||
![]() ![]() |
0..* | Annotation | Further information about the statement | |||||
![]() ![]() |
0..* | Dosage | Details of how medication is/was taken or should be taken | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationStatement.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| MedicationStatement.status | Base | required | Medication status codes | 📍4.0.1 | FHIR Std. |
| MedicationStatement.statusReason | Base | example | SNOMED CT Drug Therapy Status codes | 📍4.0.1 | FHIR Std. |
| MedicationStatement.category | Base | preferred | Medication usage category codes | 📍4.0.1 | FHIR Std. |
| MedicationStatement.medication[x] | Base | required | http://hl7.org/fhir/who-int/core/ImplementationGuide/core/ValueSet/medicationbirthcontrolmethods-values | Not State | Unknown |
| MedicationStatement.reasonCode | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | MedicationStatement | 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 | MedicationStatement | 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 | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | MedicationStatement | 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()
|
This structure is derived from MedicationStatement
Other representations of profile: CSV, Excel, Schematron