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-deviceusestatement-requested-contraceptive-method | Version: 0.2.0 | |||
| Draft as of 2026-11-19 | Computable Name: WHO-FP DeviceUseStatement (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..* | DeviceUseStatement | 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 + Binding: DeviceUseStatementStatus (required): A coded concept indicating the current status of the Device Usage. | |
![]() ![]() |
1..1 | Reference(Patient | Group) | Patient using device | |
![]() ![]() |
1..1 | Reference(WHO-FP Device (Contraceptive Method)) | Reference to device used | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DeviceUseStatement.status | Base | required | DeviceUseStatementStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | DeviceUseStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DeviceUseStatement | 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 | DeviceUseStatement | 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 | DeviceUseStatement | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DeviceUseStatement | 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 DeviceUseStatement
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | DeviceUseStatement | Method requested | |
![]() ![]() |
1..1 | Reference(WHO-FP Device (Contraceptive Method)) | Reference to device used | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | DeviceUseStatement | 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 for this record | |||||
![]() ![]() |
0..* | Reference(ServiceRequest) | Fulfills plan, proposal or order | |||||
![]() ![]() |
1..1 | code | active | completed | entered-in-error + Binding: DeviceUseStatementStatus (required): A coded concept indicating the current status of the Device Usage. | |||||
![]() ![]() |
1..1 | Reference(Patient | Group) | Patient using device | |||||
![]() ![]() |
0..* | Reference(ServiceRequest | Procedure | Claim | Observation | QuestionnaireResponse | DocumentReference) | Supporting information | |||||
![]() ![]() |
0..1 | How often the device was used | ||||||
![]() ![]() ![]() |
Timing | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() |
0..1 | dateTime | When statement was recorded | |||||
![]() ![]() |
0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Who made the statement | |||||
![]() ![]() |
1..1 | Reference(WHO-FP Device (Contraceptive Method)) | Reference to device used | |||||
![]() ![]() |
0..* | CodeableConcept | Why device was used | |||||
![]() ![]() |
0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference | Media) | Why was DeviceUseStatement performed? | |||||
![]() ![]() |
0..1 | CodeableConcept | Target body site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
![]() ![]() |
0..* | Annotation | Addition details (comments, instructions) | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DeviceUseStatement.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DeviceUseStatement.status | Base | required | DeviceUseStatementStatus | 📍4.0.1 | FHIR Std. |
| DeviceUseStatement.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | DeviceUseStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DeviceUseStatement | 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 | DeviceUseStatement | 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 | DeviceUseStatement | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DeviceUseStatement | 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 DeviceUseStatement
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | DeviceUseStatement | 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 + Binding: DeviceUseStatementStatus (required): A coded concept indicating the current status of the Device Usage. | |
![]() ![]() |
1..1 | Reference(Patient | Group) | Patient using device | |
![]() ![]() |
1..1 | Reference(WHO-FP Device (Contraceptive Method)) | Reference to device used | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DeviceUseStatement.status | Base | required | DeviceUseStatementStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | DeviceUseStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DeviceUseStatement | 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 | DeviceUseStatement | 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 | DeviceUseStatement | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DeviceUseStatement | 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 DeviceUseStatement
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | DeviceUseStatement | Method requested | |
![]() ![]() |
1..1 | Reference(WHO-FP Device (Contraceptive Method)) | Reference to device used | |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | DeviceUseStatement | 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 for this record | |||||
![]() ![]() |
0..* | Reference(ServiceRequest) | Fulfills plan, proposal or order | |||||
![]() ![]() |
1..1 | code | active | completed | entered-in-error + Binding: DeviceUseStatementStatus (required): A coded concept indicating the current status of the Device Usage. | |||||
![]() ![]() |
1..1 | Reference(Patient | Group) | Patient using device | |||||
![]() ![]() |
0..* | Reference(ServiceRequest | Procedure | Claim | Observation | QuestionnaireResponse | DocumentReference) | Supporting information | |||||
![]() ![]() |
0..1 | How often the device was used | ||||||
![]() ![]() ![]() |
Timing | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() |
0..1 | dateTime | When statement was recorded | |||||
![]() ![]() |
0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Who made the statement | |||||
![]() ![]() |
1..1 | Reference(WHO-FP Device (Contraceptive Method)) | Reference to device used | |||||
![]() ![]() |
0..* | CodeableConcept | Why device was used | |||||
![]() ![]() |
0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference | Media) | Why was DeviceUseStatement performed? | |||||
![]() ![]() |
0..1 | CodeableConcept | Target body site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
![]() ![]() |
0..* | Annotation | Addition details (comments, instructions) | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DeviceUseStatement.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DeviceUseStatement.status | Base | required | DeviceUseStatementStatus | 📍4.0.1 | FHIR Std. |
| DeviceUseStatement.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | DeviceUseStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DeviceUseStatement | 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 | DeviceUseStatement | 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 | DeviceUseStatement | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DeviceUseStatement | 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 DeviceUseStatement
Other representations of profile: CSV, Excel, Schematron