WHO Family Planning Implementation Guide
0.2.0 - CI Build International flag

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

Resource Profile: WHO-FP DeviceUseStatement (Requested Contraceptive Method)

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:

  • This Profile is not used by any profiles in this Specification

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DeviceUseStatement 0..* DeviceUseStatement Method requested
DeviceUseStatement.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DeviceUseStatement.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
DeviceUseStatement.status This element is a modifier element. This element is included in summaries. 1..1 code active | completed | entered-in-error +
Binding: DeviceUseStatementStatus (required): A coded concept indicating the current status of the Device Usage.
DeviceUseStatement.subject This element is included in summaries. 1..1 Reference(Patient | Group) Patient using device
DeviceUseStatement.device This element must be supported. This element is included in summaries. 1..1 Reference(WHO-FP Device (Contraceptive Method)) Reference to device used

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DeviceUseStatement.status Base required DeviceUseStatementStatus 📍4.0.1 FHIR Std.

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DeviceUseStatement 0..* DeviceUseStatement Method requested
DeviceUseStatement.device This element must be supported. 1..1 Reference(WHO-FP Device (Contraceptive Method)) Reference to device used

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
DeviceUseStatement 0..* DeviceUseStatement Method requested
DeviceUseStatement.id This element is included in summaries. 0..1 id Logical id of this artifact
DeviceUseStatement.meta This element is included in summaries. 0..1 Meta Metadata about the resource
DeviceUseStatement.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DeviceUseStatement.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
DeviceUseStatement.text 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
DeviceUseStatement.contained 0..* Resource Contained, inline Resources
DeviceUseStatement.extension 0..* Extension Additional content defined by implementations
DeviceUseStatement.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
DeviceUseStatement.identifier This element is included in summaries. 0..* Identifier External identifier for this record
DeviceUseStatement.basedOn This element is included in summaries. 0..* Reference(ServiceRequest) Fulfills plan, proposal or order
DeviceUseStatement.status This element is a modifier element. This element is included in summaries. 1..1 code active | completed | entered-in-error +
Binding: DeviceUseStatementStatus (required): A coded concept indicating the current status of the Device Usage.
DeviceUseStatement.subject This element is included in summaries. 1..1 Reference(Patient | Group) Patient using device
DeviceUseStatement.derivedFrom This element is included in summaries. 0..* Reference(ServiceRequest | Procedure | Claim | Observation | QuestionnaireResponse | DocumentReference) Supporting information
DeviceUseStatement.timing[x] This element is included in summaries. 0..1 How often the device was used
DeviceUseStatement.timing[x].timingTiming Timing
DeviceUseStatement.timing[x].timingPeriod Period
DeviceUseStatement.timing[x].timingDateTime dateTime
DeviceUseStatement.recordedOn This element is included in summaries. 0..1 dateTime When statement was recorded
DeviceUseStatement.source This element is included in summaries. 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) Who made the statement
DeviceUseStatement.device This element must be supported. This element is included in summaries. 1..1 Reference(WHO-FP Device (Contraceptive Method)) Reference to device used
DeviceUseStatement.reasonCode This element is included in summaries. 0..* CodeableConcept Why device was used
DeviceUseStatement.reasonReference This element is included in summaries. 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference | Media) Why was DeviceUseStatement performed?
DeviceUseStatement.bodySite This element is included in summaries. 0..1 CodeableConcept Target body site
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
DeviceUseStatement.note 0..* Annotation Addition details (comments, instructions)

doco Documentation for this format

Terminology Bindings

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.

Constraints

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

Summary

Must-Support: 1 element

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DeviceUseStatement 0..* DeviceUseStatement Method requested
DeviceUseStatement.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DeviceUseStatement.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
DeviceUseStatement.status This element is a modifier element. This element is included in summaries. 1..1 code active | completed | entered-in-error +
Binding: DeviceUseStatementStatus (required): A coded concept indicating the current status of the Device Usage.
DeviceUseStatement.subject This element is included in summaries. 1..1 Reference(Patient | Group) Patient using device
DeviceUseStatement.device This element must be supported. This element is included in summaries. 1..1 Reference(WHO-FP Device (Contraceptive Method)) Reference to device used

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DeviceUseStatement.status Base required DeviceUseStatementStatus 📍4.0.1 FHIR Std.

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DeviceUseStatement 0..* DeviceUseStatement Method requested
DeviceUseStatement.device This element must be supported. 1..1 Reference(WHO-FP Device (Contraceptive Method)) Reference to device used

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DeviceUseStatement 0..* DeviceUseStatement Method requested
DeviceUseStatement.id This element is included in summaries. 0..1 id Logical id of this artifact
DeviceUseStatement.meta This element is included in summaries. 0..1 Meta Metadata about the resource
DeviceUseStatement.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DeviceUseStatement.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
DeviceUseStatement.text 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
DeviceUseStatement.contained 0..* Resource Contained, inline Resources
DeviceUseStatement.extension 0..* Extension Additional content defined by implementations
DeviceUseStatement.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
DeviceUseStatement.identifier This element is included in summaries. 0..* Identifier External identifier for this record
DeviceUseStatement.basedOn This element is included in summaries. 0..* Reference(ServiceRequest) Fulfills plan, proposal or order
DeviceUseStatement.status This element is a modifier element. This element is included in summaries. 1..1 code active | completed | entered-in-error +
Binding: DeviceUseStatementStatus (required): A coded concept indicating the current status of the Device Usage.
DeviceUseStatement.subject This element is included in summaries. 1..1 Reference(Patient | Group) Patient using device
DeviceUseStatement.derivedFrom This element is included in summaries. 0..* Reference(ServiceRequest | Procedure | Claim | Observation | QuestionnaireResponse | DocumentReference) Supporting information
DeviceUseStatement.timing[x] This element is included in summaries. 0..1 How often the device was used
DeviceUseStatement.timing[x].timingTiming Timing
DeviceUseStatement.timing[x].timingPeriod Period
DeviceUseStatement.timing[x].timingDateTime dateTime
DeviceUseStatement.recordedOn This element is included in summaries. 0..1 dateTime When statement was recorded
DeviceUseStatement.source This element is included in summaries. 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) Who made the statement
DeviceUseStatement.device This element must be supported. This element is included in summaries. 1..1 Reference(WHO-FP Device (Contraceptive Method)) Reference to device used
DeviceUseStatement.reasonCode This element is included in summaries. 0..* CodeableConcept Why device was used
DeviceUseStatement.reasonReference This element is included in summaries. 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference | Media) Why was DeviceUseStatement performed?
DeviceUseStatement.bodySite This element is included in summaries. 0..1 CodeableConcept Target body site
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
DeviceUseStatement.note 0..* Annotation Addition details (comments, instructions)

doco Documentation for this format

Terminology Bindings

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.

Constraints

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

Summary

Must-Support: 1 element

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron