Current Build

FPAR on FHIR Implementation Guide (IG)

Background

The U.S. Department of Health and Human Services’ Office of Population Affairs (OPA) has administered the National Family Planning Program since 1970. This program, authorized under Title X of the Public Health Service Act, is the only federal program dedicated solely to the provision of family planning and related preventive health care. The program is designed to provide contraceptive services and information to all who want and need them. In addition to offering a broad range of effective contraceptive methods on a voluntary and confidential basis, Title-X clinics provide contraceptive education and counseling; breast and cervical cancer screening; sexually transmitted disease (STD) and human immunodeficiency virus (HIV) testing, referral, and prevention education; and pregnancy diagnosis and counseling. The program is implemented through grants to over 90 public health departments and community health, family planning, and other private nonprofit agencies in all 50 states and U.S. Territories. These grants support delivery of Title X services in approximately 4,000 clinical sites. The program serves approximately four (4) million women and men of reproductive age each year through over seven (7) million patient encounters.

OPA currently collects aggregate data from Title X grantees on an annual basis. The data are compiled and published each year in the Family Planning Annual Report (FPAR). The FPAR is the only source of uniform reporting by all Title X services grantees, and results are used to monitor compliance with statutory requirements, comply with accountability and federal performance reporting requirements for Title X family planning funds, guide strategic and financial planning, respond to inquiries from policy makers and Congress about Title X, and estimate the impact of Title X-funded activities on key reproductive health outcomes, including prevention of unintended pregnancy, infertility, and invasive cervical cancer.

Current aggregate data collected through FPAR reporting processes limit OPA’s capacity to monitor data quality and to conduct patient-level analyses that are more informative and useful to service delivery efforts. OPA has been assessing the feasibility of implementing an interoperable data reporting system since 2012. A CDA-based Family Planning Profile has been developed and tested in collaboration with IHE International.

OPA has created this FHIR standard and implementation guide to collect a set of standardized and agreed upon data elements from all encounters across the 4,000 Title X clinical sites. The goals of this standard are as follows:

  1. Improve the quality of data sent to OPA to improve the ability to assess key performance metrics related to family planning and reproductive health;
  2. Contribute to a learning healthcare environment by sending quality improvement-related information back to Title X providers;
  3. Reduce the burden of annual reporting requirements on the Title X network; and,
  4. Make the FHIR standard publicly available to all reproductive health providers outside of the Title X network so they can collect standardized family planning data and calculate performance metrics on their own.

Overview

Family planning and related reproductive health services are essential elements of preventive health care, yet many aspects are not integrated and captured within electronic health record (EHR) systems. Measuring pregnancy intention, sexual activity history, and counseling related to contraception or achieving pregnancy are important health indicators that are not consistently captured by EHRs, yet are desired by clinicians, healthcare administrators, academic researchers, and government programs. The lack of standardized data capture for reporting, monitoring, and evaluation of family planning services to public health authorities places a burden on already stretched clinical providers. Additionally, many data elements important to family planning providers are critical to other clinical domains (e.g., blood pressure), while others are currently used primarily in family planning settings (e.g., client’s pregnancy intention). Standardized capture and recording of these variables across multiple clinical settings and diverse medical record documentation would facilitate more efficient reporting, adherence to clinical guidelines, and efforts to improve quality of service provision.

Within the Title X family planning program network, many of the 4,000 clinical service sites have an EHR capable of recording discrete patient data. Over 100 EHR vendors are represented across this network, however, necessitating the creation of interoperability standards that include standardized data elements using common terminologies. To cast a broad net, OPA has developed a CCDA-based profile with IHE International, in addition to this FHIR standard. All attempts were made to align the CCDA and FHIR standards and to use common terminologies.

Authors

NameOrganizationEmail
Emily DeckerOffice of Population AffairsEmily.Decker@hhs.gov
Brittni FrederiksenOffice of Population AffairsBrittni.Frederiksen@hhs.gov
Stephen Hasley, MDAmerican College of Obstetrics and Gynecologistsshasley@acog.org
Susan MatneyIntermountain Healthcaresusan.matney@imail.org
Bret HealeIntermountain Healthcarebret.heale@imail.org
Nathan DavisIntermountain HealthcareNathan.Davis2@imail.org
Patrick LangfordIntermountain HealthcarePatrick.Langford@imail.org

Overview

Name Definition
Family Planning Annual Report The Office of Population Affairs (OPA) family practice annual reporting (FPAR) is an annual reporting requirement for family planning services delivery projects authorized and funded under the Population Research and Voluntary Family Planning Programs (Section 1001 of Title X of the Public Health Service Act, 42 United States Code [USC] 300).
Family Planning Annual Report: 2016 national summary Fowler, C.I., Gable, J., Wang, J., & Lasater, B. (2017, August). Family Planning Annual Report: 2016 national summary. Research Triangle Park, NC: RTI International.

This guide defines the following profiles to be used to meet the FPAR reporting data elements. Note: For lab observations, the path for the date of the lab is Observation.effective[x], the path for the result of the lab is Observation.value[x], and the path for the LOINC code is Observation.code.

Non-lab data element crosswalk

FPAR data element FHIR profile or profile element
Facility Identifier fpar-organization.id (within the fpar-organization profile)
Clinical Provider Identifier fpar-practitioner.identifier (within fpar-practitioner profile)
Clinical Provider Role fpar-practitionerRole.specialty (within fpar-practitionerRole profile)
Visit Date fpar-generalencounterperiod.start (within fpar-genEncounter profile)
Annual Household Income hspc-annualHouseholdIncome
Household Size hspc-householdSize
Smoking status hspc-smokingStatus
Insurance Coverage Type fpar-coverage.type (within fpar-coverage profile)
Payer for Visit extensions-primaryInsuranceClassification (within fpar-coverage profile)
Date of Birth fpar-patient.birthDate (within fpar-patient profile)
Birth Sex fpar-patient.extension:birthsex (within fpar-patient profile)
Race fpar-patient.extension:race (within fpar-patient profile)
Ethnicity fpar-patient.extension:ethnicity (within fpar-patient profile)
Limited English Proficiency fpar-limitedEnglishProficiencyEval
Patient Identifier fpar-patient.identifier (within fpar-patient profile)
Height hspc-height
Weight hspc-bodyWeight
Systolic blood pressure hspc-systolicbp
Diastolic blood pressure hspc-diastolicbp
Parity hspc-parity
Gravidity hspc-gravidity
Pregnancy Status fpar-pregnancyStatusEval
Pregnancy Status Reporting Method fpar-pregnancyStatusEval.extension:reportingMethod (within profile)
Pregnancy test performed hspc-BHcgPregSerplQl
hspc-HcgPregSerplQl
hspc-HcgPregUrQl
hspc-HcgPregSerQlIaRapid
hspc-BHcgSerplAcnc
hspc-HcgSerplAcnc
Pregnancy Intention fpar-pregnancyIntentionEval
Ever Had Sex fpar-virginalStatusEval
Sex Last 3 Months hspc-sexLastThreeMonths
Sex Last 12 Months hspc-sexLastTwelveMonths
Contraceptive Method(s) at Intake fpar-contraceptiveChoiceInitial
Reason for no contraceptive method at intake fpar-contraceptiveChoiceInitial.dataAbsentReason (within fpar-contraceptiveChoiceInitial profile)
Contraceptive Method(s) at Exit fpar-contraceptiveChoiceAtExit
How Contraceptive Method(s) Provided At Exit fpar-contraceptiveChoiceAtExit.extension:ContraceptionProvisionMethod$Extension (within fpar-contraceptiveChoiceAtExit profile)
Reason for no contraceptive method at exit fpar-contraceptiveChoiceAtExit.dataAbsentReason (within fpar-contraceptiveChoiceAtExit profile)
Contraceptive Counseling fpar-contraceptiveCounseling
Counseling to Achieve Pregnancy fpar-counselingToAchievePregnancy
HIV Referral Recommended Date referralRequest.authoredOn
HIV Referral Visit Completed Date encounterperiod.end
Date of Last HIV test
HIV Rapid Test Result
HIV Supplemental Test Result
hspc-Hiv1RnaXxxQlPcr
hspc-Hiv1AbSerQlIb
hspc-Hiv1AbSerplbldQlEiaRapid
hspc-Hiv2AbSerQlEia
hspc-Hiv1And2AbSerQlEia
hspc-Hiv1RnaSerplPcrDl17Log
hspc-Hiv1RnaSerplPcrDl50
Date of Last HPV Co-test
HPV Test Result
hspc-HpvIHRisk4DnaCervixQlBdna
hspc-HpvIHRiskDnaCervixQlPrb
hspc-HpvIHRisk1DnaCervixQlBdna
hspc-HpvDnaCervixQlBdna
hspc-HpvIHRisk1DnaXxxQlPcr
hspc-HpvE6AndE7MrnaCervixQlPcr
hspc-Hpv12HrTypesDnaTissQlPrb
hspc-HpvCervix
hspc-Hpv16And18AgGenitalQl
hspc-Hpv16And18AgCervixQl
hspc-Hpv16And18AgVagQl
hspc-Hpv16And18AgUrthQl
hspc-Hpv16And18AgXxxQl
hspc-HpvDnaCervixQlPrb
hspc-HpvRrnaGenitalQlPcr
hspc-HpvRrnaXxxQlPcr
Date of Last CT test
CT Test Result
hspc-CTrachDnaXxxPcrAcnc
hspc-CTrachRrnaXxxQlPcr
hspc-CTrachDnaUrthQlPcr
hspc-CTrachRrnaXxxQlPrb
hspc-CTrachRrnaGenitalQlPrb
hspc-CTrachRrnaUrQlPrb
hspc-CTrachDnaCervMucusQlPcr
hspc-CTrachDnaCervixQlPcr
hspc-CTrachRrnaUrthQlPrb
hspc-CTrachDnaXxxQlPcr
hspc-CTrachRrnaGenitalFlQlPrb
hspc-ChlamydiaDnaXxxQlPcr
hspc-CTrachRrnaUrQlPcr
hspc-CTrachDnaXxxQlBdna
hspc-CTrachRrnaCervixQlPrb
hspc-CTrachRrnaVagQlPrb
hspc-CTrachDnaVagQlPcr
hspc-CTrachL2DnaXxxQlPcr
hspc-CTrachDnaXxxPcr
hspc-CTrachRrnaCervixQlPcr
hspc-CTrachRrnaUrthQlPcr
hspc-CTrachRrnaVagQlPcr
hspc-CTrachDnaGenitalQlPcr
hspc-CTrachDnaUrQlPcr
Date of Last GC test
GC Test Result
hspc-NGonorrhoeaRrnaXxxQlPcr
hspc-NGonorrhoeaDnaUrthQlPcr
hspc-NGonorrhoeaDnaGenitalQlPcr
hspc-NGonorrhoeaRrnaCervixQlPcr
hspc-NGonorrhoeaDnaCervMucusQlPcr
hspc-NGonorrhoeaDnaUrQlPcr
hspc-NGonorrhoeaDnaXxxQlPcr
hspc-NGonorrhoeaRrnaCervixQlPrb
hspc-NGonorrhoeaRrnaUrthQlPrb
hspc-NGonorrhoeaDnaVagQlPcr
hspc-NGonorrhoeaDnaXxxQlBdna
hspc-NGonorrhoeaRrnaXxxQlPrb
hspc-NGonorrhoeaRrnaVagQlPcr
hspc-NGonorrhoeaRrnaUrthQlPcr
hspc-NGonorrhoeaAgGenitalQlEia
hspc-NGonorrhoeaCervixQlCult
hspc-NGonorrhoeaGenitalQlCult
hspc-NGonorrhoeaGenLochiaQlCult
hspc-NGonorrhoeaVagQlCult
hspc-NGonorrhoeaXxxQlCult
Date of Last CT test
CT Test Result
Date of Last GC test
GC Test Result
hspc-CtrachAndGCDNAXXXQlPCR
hspc-CTrachAndGcDnaXxxPcr
hspc-CTrachAndGcDnaXxxQlBdna
hspc-CTrachAndGcDnaUrQlPcr
hspc-CTrachAndGcDnaGenitalQlPcr
hspc-CTrachAndGcRrnaCervixQlPrb
hspc-CTrachAndGcDnaCervixQlPcr
hspc-CTrachAndGcRrnaGenitalQlPrb
hspc-CTrachAndGcRrnaVagQlPrb
hspc-CTrachAndGcRrnaUrQlPrb
hspc-CTrachAndGcRrnaXxxQlPrb
Date of Pap Tests Last 5 Years
Last Pap Result
hspc-CytoCervix
hspc-CytoCvxVag
hspc-CytoCvxVagCoded
hspc-CytologyCmntCvxVagCytoImp
hspc-CytologyCvxVagDocCyto
hspc-CytologyCvxVagDocThinPrep
hspc-GenCategCvxVagCytoImp
hspc-StatOfAdqCvxVagCytoImp
hspc-StudyreportFindPtCvxVagDocCytology
hspc-ThinPrepCervix

Lab data element crosswalk

LOINC code LOINC Name FPAR data element Set Members
86636-8   Family planning report - FPAR 2.0 set
     75524-9   Facility identifier Facility Identifier
     68468-8   Attending physician NPI Provider Clinical Provider Identifier
     86637-6   Provider role Clinical Provider Role
     76427-4   Visit date Visit Date
     86638-4   Patient demographic and administrative information panel [FPAR]
          77244-2   Which category represents the total combined income of all members of your FAMILY during the past 12 months? Annual Household Income
          86639-2   Household size [#] Household Size
          72166-2   Tobacco smoking status NHIS Smoking status
          87520-3   Primary insurance Insurance Coverage Type
          52556-8   Payment sources Payer for Visit
          21112-8   Birth date Date of Birth
          46098-0   Sex Birth Sex
          32624-9   Race Race
          69490-1   Ethnicity OMB.1997 Ethnicity
          86640-0   Limited English proficiency Qualitative Limited English Proficiency
          76435-7   Patient identifier Patient Identifier
     86641-8   Height, weight and blood pressure panel [FPAR]
          8302-2   Body height Height
          29463-7   Body weight Weight
          8480-6   Systolic blood pressure Systolic blood pressure
          8462-4   Diastolic blood pressure Diastolic blood pressure
     86642-6   Pregnancy and contraception panel [FPAR]
          11977-6   [#] Parity Parity
          11996-6   [#] Pregnancies Gravidity
          82810-3   Pregnancy status Pregnancy Status
          86643-4   Information source for pregnancy status Pregnancy Status Reporting Method
          86645-9   Future pregnancy intention Reported Pregnancy Intention
          86646-7   Ever had sex - Reported Ever Had Sex
          86647-5   Sex in the last 3 months - Reported Sex Last 3 Months
          86648-3   Sex in the last year - Reported Sex Last 12 Months
          86649-1   Birth control method Reported --at intake Contraceptive Method(s) at Intake
          86650-9   Reason for no birth control use Reported --at intake Reason for no contraceptive method at intake
          86651-7   Birth control method Reported --at exit Contraceptive Method(s) at Exit
          86652-5   How birth control method was provided How Contraceptive Method(s) Provided At Exit
          86653-3   Reason for no birth control use Reported --at exit Reason for no contraceptive method at exit
          86654-1   Contraceptive counseling was provided Contraceptive Counseling
          86655-8   Counseling to achieve pregnancy was provided Counseling to Achieve Pregnancy
     86663-2   HIV referral information panel [FPAR]
          57202-4   Date of Referral [CMS Assessment] HIV Referral Recommended Date
          76427-4   Visit date HIV Referral Visit Completed Date
          86657-4   HIV 1 and 2 tests - FPAR 2.0 set Date of Last HIV test
HIV Rapid Test Result
HIV Supplemental Test Result
5018-7, 5221-7,
68961-2, 30361-0,
31201-7, 48510-2,
48511-0
          86658-2   HPV tests - FPAR 2.0 set Date of Last HPV Co-test
HPV Test Result
59420-0, 21440-3,
30167-1, 38372-9,
49896-4, 69002-4,
73959-9, 11083-3,
12223-4, 14503-7,
14504-5, 14506-0,
17400-3, 44550-2,
6514-4, 6516-9
          86659-0   Chlamydia sp tests - FPAR 2.0 set Date of Last CT test
CT Test Result
49096-1, 43304-5,
21191-2, 4993-2,
16600-9, 16601-7,
21189-6, 21190-4,
21192-0, 21613-5,
23838-6, 35729-3,
42931-6, 43404-3,
45078-3, 45080-9,
45084-1, 47211-8,
47212-6, 50387-0,
53925-4, 53926-2,
6356-0, 6357-8
          86660-8   Neisseria gonorrhoeae tests - FPAR 2.0 set Date of Last GC test
GC Test Result
43305-2, 21415-5,
47387-6, 50388-8,
21414-8, 21416-3,
24111-7, 32198-4,
32199-2, 32705-6,
43403-5, 5028-6,
53879-3, 53927-0,
6487-3, 688-2,
691-6, 692-4,
693-2, 698-1
          86661-6   Chlamydia trachomatis+ Neisseria gonorrhoeae tests - FPAR 2.0 set Date of Last CT test
CT Test Result
Date of Last GC test
GC Test Result
36902-5, 36903-3,
43406-8, 44806-8,
44807-6, 45067-6,
45068-4, 45069-2,
45070-0, 45074-2,
45076-7
          86662-4   Pap smear tests - FPAR 2.0 set Date of Pap Tests Last 5 Years
Last Pap Result
10524-7, 19766-5,
19765-7, 19774-9,
47528-5, 47527-7,
19762-4, 19764-0,
33717-0, 18500-9

This guide references the following value sets.

Value Set Name Descripton url
FPAR Pregnancy Status Pregnancy status at time of encounter. ValueSet-pregnancyStatus
FPAR Sexual Intercourse History Values used to indicate weather or not a patient has ever had sexual intercourse. ValueSet-virginNonVirgin
FPAR Contraceptive Type This values contains both clinical and non-clinical contraceptive types. ValueSet-contraceptiveChoice
FPAR Contraception Not Used Reason Reasons why contraception is not being used. ValueSet-reasonNoContraceptiveChosen
FPAR Contraceptive Provision Method Indicating how contraception provided at a high-level during a clinical encounter. ValueSet-contraceptionProvisionMethod
FPAR Pregnancy Intent Values describing patient intentions to become pregnant. ValueSet-pregnancyIntention
FPAR Pregnancy Status Reporting Method Method used to report and/or determine pregnancy status. ValueSet-pregnancyStatusReportingMethod
FPAR Clinical Provider Role Clinical provider occupational roles. ValueSet-fparProviderRole
FPAR Annual Household Income Ranges Household annual income range. ValueSet-fparAnnualHouseholdIncomeRanges
FPAR Insurance Coverage Type Source of Payment Typology codes for a low granularity description of Insurance coverage. ValueSet-coverageType
FPAR English Proficiency Patient's level of proficiency in English in four domains: listening, writing, reading, or speaking. ValueSet-englishProficiency
Smoking Status Classification of a patient's smoking behavior. This value set is consistent with the Smoking Status codes used by ONC for Meaningful Use ValueSet-fparSmokingStatus
Payer Typology Used to describe the type of the primary payer for the visit. ValueSet-primaryInsuranceClassification
EthnicGroup The codes for the ethnicity categories - 'Hispanic or Latino' and 'Non Hispanic or Latino' - as defined by the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997. https://www.hl7.org/fhir/us/core/ValueSet-omb-ethnicity-category.html
BirthSex Codes for assigning sex at birth as specified by the Office of the National Coordinator for Health IT (ONC) https://www.hl7.org/fhir/us/core/ValueSet-us-core-birthsex.html
Race The codes for the concepts 'Unknown' and 'Asked but no answer' and the the codes for the five race categories - 'American Indian' or 'Alaska Native', 'Asian', 'Black or African American', 'Native Hawaiian or Other Pacific Islander', and 'White' - as defined by the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997 . https://www.hl7.org/fhir/us/core/ValueSet-omb-race-category.html
FPAR RNA Detection Ordinal values used to result RNA detection based laboratory tests. For example LOINC code 5018-7, HIV 1 RNA [Presence] in Unspecified specimen by Probe and target amplification method. ValueSet-fparHIV1RnaDetectedNotDetected
FPAR Positive Negative Ordinal values for Positive and Negative results. ValueSet-negativePositive
FPAR Organism Detection Ordinal lab results that reflect microorganism presence. ValueSet-organismDetectionOrdLabResult
FPAR Detected, Not Detected, Equivocal Inconclusive Ordinal values for Detected and Not Detected results, with the inclusion of Equivocal and Inconclusive. ValueSet-fparDetectedNonDetectedEqInd
FPAR Detected, Not Detected Ordinal values for Detected and Not Detected results. ValueSet-fparDetectedNotDetected
FPAR Antibody Reactivity Positive Negative Ordinal values used to result antibody based laboratory tests. For example LOINC code 5221-7, HIV 1 Ab [Presence] in Serum by Immunoblot (IB). ValueSet-fparHIVAbReactiveNonReactive
FPAR Pap Smear Tests Laboratory tests for PAP Smear tests, used to retrieve and populate dates for PAP Smear labs. ValueSet-papSmearTests
FPAR HIV Tests Laboratory tests for HIV, used to retrieve and populate dates for Human Immunodeficiency Virus labs. ValueSet-hivTests
FPAR Human Papilloma Virus Tests Laboratory tests for Human Papilloma virus, used to retrieve and populate dates for Human Papilloma virus labs. ValueSet-humanPapillomaVirusTests
FPAR Chlamydia Trachomatis Tests Laboratory tests for Human Papilloma virus, used to retrieve and populate dates for Human Papilloma virus labs. ValueSet-chlamydiaTrachomatisTests
FPAR Neisseria Gonorrhoeae Tests Laboratory test exclusively for Neisseria gonorrhoeae, used to retrieve and populate dates for Neisseria gonorrhoeae labs. ValueSet-neisseriaGonorrhoeaeTests
FPAR Chlamydia trachomatis and Neisseria Gonorrhoeae combined Tests Laboratory tests which test for both Chlamydia trachomatis and Neisseria gonorrhoeae, used to retrieve and populate dates for Chlamydia trachomatis and Neisseria gonorrhoeae labs. ValueSet-chlamydiaTrachomatisAndNeisseriaGonorrhoeaeCombinedTests
FPAR Pregnancy Tests Contains the LOINC codes for the labs used for Preganacy status determination. ValueSet-pregnancyTests

This guide references the following extensions.

Extension Profiles that use the extension
administrativeEncounterId fpar-genEncounter
admitMedicationId fpar-genEncounter
ambulatoryStatus fpar-genEncounter
arrivedByTransportation fpar-genEncounter
associatedPrecondition hspc-height, hspc-systolicbp, hspc-diastolicbp, hspc-bodyWeight
bodyPosition hspc-diastolicbp, hspc-systolicbp
chiefComplaintId fpar-genEncounter
communicationMode fpar-genEncounter
confidentiality fpar-genEncounter
contraceptionProvisionMethod fpar-contraceptiveChoiceAtExit
dataAbsentReason fpar-genEncounter
dataOriginationMode hspc-height, hspc-bodyWeight
deltaFlag all lab observation profiles
departedByTransportation fpar-genEncounter
dischargeMedicationId fpar-genEncounter
focalSubject hspc-systolicbp, hspc-diastolicbp
hospitalService fpar-genEncounter
organizationPeriod fpar-organization
primaryInsuranceClassification fpar-coverage
reasonCancelled fpar-genEncounter
reportingMethod fpar-pregnancyStatusEval
vipLevel fpar-genEncounter