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

Conversion to FSH

On 2026-11-10 this IG was converted from an XML ImplementationGuide (input/fp-cds.xml plus JSON resources) to FSH, built with sushi (0 errors). This page lists every change, with the pull request that made it.

Changes in meaning (read these first)

These change what the profiles and value sets allow. They were approved by the repository owner as draft fixes. Items marked guess need review by the content owners.

What Before After PR
Medical eligibility number value[x] integer with a required binding to medicaleligibilitynumber-values, which has no codes no binding; integer from 1 to 4 (the WHO MEC categories) #6
DeviceUseStatement (Exit) and (Requested) required binding on device.type, which is Reference.type (a uri), not the device's type device only references the new profile WHO-FP Device (Contraceptive Method), whose type (1..1) has the required binding to devicebirthcontrolmethods-values. In the Requested profile the ICD-10 Z30.9 code moved from device.type to device. #6
contraception-issues-and-concerns-values ICD-10 N89.8 listed twice ("Spotting or light bleeding", "Unexplained vaginal bleeding") listed once, displays joined with " / " (guess) #6
medicaleligibilityconditions-values CIEL 159276 (DVT, PE), CIEL 144475 (Stroke, Stroke (history of CVA)), ICD-11 BD72 (DVT, History of DVT, History of PE), 8B20 (Stroke, Stroke (history of CVA)), 5A14 (Diabetes, Nephropathy, Retinopathy) each listed more than once each listed once, displays joined with " / " (guess: some of these probably need different codes, for example DVT and PE) #6
12 elements in 11 profiles (table below) cardinality looser than the base resource allows the base cardinality #5
deliveryMethod extension Extension.extension 0..1 next to a value Extension.extension 0..0 (a simple extension cannot also have sub-extensions) #5

Cardinalities brought back to the base (#5):

Profile Element Before After (base)
CarePlan (Backup Contraceptive Method) activity.detail.code 0..* 0..1
CarePlan (Exit Contraceptive Method) activity.detail.code 0..* 0..1
DeviceUseStatement (Exit) device.type 0..* 0..1 (later replaced by the Device profile, see above)
MedicationStatement (Current Medication) medication[x] 0..* 1..1
MedicationStatement (Exit Contraceptive Method) medication[x] 0..* 1..1
MedicationStatement (Requested Contraceptive Method) medication[x] 0..1 1..1
Observation (Breastfeeding Status) value[x] 0..* 0..1
Observation (Medical Eligibility) code 0..1 1..1
Observation (Reason for Stopping Contraception) valueCodeableConcept 0..* 0..1
Procedure (Exit Contraceptive Method) code 0..* 0..1
Procedure (Service Provided) status 0..1 1..1

Changes with no change in meaning

The conversion itself (#3) kept every resource as it was. The JSON that sushi generated was compared with the original JSON:

  • All 15 value sets and the deliveryMethod extension: identical, field by field. (At that stage the extension and two value sets were still kept as JSON; #5 and #6 later moved them to FSH with the changes above.)
  • The code system: identical apart from count: 9, which sushi adds.
  • Profiles: snapshots were built for both versions with fhir-snapshot-generator against hl7.fhir.r4.core 4.0.1, and 25 of 26 are identical. The one difference: CarePlan.activity.detail.extension gets the default slicing by url, which the IG Publisher normally adds to extension elements anyway. The tool could not snapshot 3 profiles; their differentials differ only by cardinalities equal to the base.
  • The ImplementationGuide keeps the XML IG's id, canonical, version, name, title, publisher, contact, jurisdiction, page tree and parameters. The menu is now generated from sushi-config.yaml with the same entries.

How the raw JSON differs in form, without changing meaning:

Difference Why
min/max equal to the base are left out (60 places in 29 profiles) sushi only writes what changes the base.
Observation.valueX is written as value[x] with only X FSH has no renamed-path form; the snapshot is the same.
Reason for Stopping Contraception: value[x] limited to CodeableConcept or string, with two type slices same constraints in sushi's form.
CodeSystem.count added sushi fills it in.

Build and publishing changes

Change PR
input/fp-cds.xml, the JSON profiles, the code system and value sets replaced by input/fsh/; sushi-config.yaml added; ig.ini points at the generated IG; input/includes/menu.xml now generated #3
Site publish wiring: root package.json and bunfig.toml, re-pinned index.config.json and index.lock.json, updated site-publish.yml #3
This page, linked from Home #4