Skip to main content

General Purpose R4 Supported Extensions

Overview

This page documents the FHIR extensions supported by the Netsmart General Purpose R4 API. Extensions provide additional data elements beyond the base FHIR specification to support specific healthcare workflows and data requirements.

Important: The extensions listed below are based on the current CapabilityStatement. Always validate extension support by retrieving the latest CapabilityStatement from the API endpoint.

Retrieving Current Extension Support

Before implementing extensions, retrieve the current CapabilityStatement to validate which extensions are supported:

# Production Environment
curl -X GET https://fhir.netsmartcloud.com/v4/metadata \
-H "Accept: application/fhir+json"

# Preview Environment
curl -X GET https://fhirtest.netsmartcloud.com/v4/metadata \
-H "Accept: application/fhir+json"

Supported Extensions by Resource

Basic

NameURI
Call Intake Callerhttps://fhir.netsmartcloud.com/v4/StructureDefinition/callintake-caller
Call Intake Datehttps://fhir.netsmartcloud.com/v4/StructureDefinition/callintake-date
Call Intake Dispositionhttps://fhir.netsmartcloud.com/v4/StructureDefinition/callintake-disposition
Call Intake Patient Namehttps://fhir.netsmartcloud.com/v4/StructureDefinition/callintake-patient-name
Call Intake Programhttps://fhir.netsmartcloud.com/v4/StructureDefinition/callintake-program
Call Intake Remarkshttps://fhir.netsmartcloud.com/v4/StructureDefinition/callintake-remarks
Call Intake Typehttps://fhir.netsmartcloud.com/v4/StructureDefinition/callintake-type

Condition

NameURI
Condition Abortus Codehttps://fhir.netsmartcloud.com/v4/StructureDefinition/condition-abortus-code
Condition CarePlanhttps://fhir.netsmartcloud.com/v4/StructureDefinition/condition-careplan
Condition CarePlan Problem Narrativehttps://fhir.netsmartcloud.com/v4/StructureDefinition/condition-careplan-problem-narrative
Condition Contraception Codehttps://fhir.netsmartcloud.com/v4/StructureDefinition/condition-contraception-code
Condition Diagnosis Bill Orderhttps://fhir.netsmartcloud.com/v4/StructureDefinition/condition-diagnosisBillOrder
Condition Diagnosis Rankhttps://fhir.netsmartcloud.com/v4/StructureDefinition/condition-diagnosisRank
Condition Diagnosis Rolehttps://fhir.netsmartcloud.com/v4/StructureDefinition/condition-diagnosisRank
Condition Ever Been Pregnant Codehttps://fhir.netsmartcloud.com/v4/StructureDefinition/condition-ever-been-pregnant-code
Condition Ever Had Ectopic Pregnancyhttps://fhir.netsmartcloud.com/v4/StructureDefinition/condition-ever-had-ectopic-pregnancy
Condition Ever Had Prenatal Care Another Facilityhttps://fhir.netsmartcloud.com/v4/StructureDefinition/condition-ever-had-prenatal-care-another-facility
Condition Expected Due Datehttps://fhir.netsmartcloud.com/v4/StructureDefinition/condition-expected-due-date
Condition Gravidahttps://fhir.netsmartcloud.com/v4/StructureDefinition/condition-gravida
Condition Living Child Detailshttps://fhir.netsmartcloud.com/v4/StructureDefinition/condition-living-child-details
Condition LNMPhttps://fhir.netsmartcloud.com/v4/StructureDefinition/condition-lnmp
Condition Miscarriage Codehttps://fhir.netsmartcloud.com/v4/StructureDefinition/condition-miscarriage-code
Condition Number of Abortushttps://fhir.netsmartcloud.com/v4/StructureDefinition/condition-number-of-abortus
Condition Number of Living Childrenhttps://fhir.netsmartcloud.com/v4/StructureDefinition/condition-number-of-living-children
Condition Number of Miscarriageshttps://fhir.netsmartcloud.com/v4/StructureDefinition/condition-number-of-miscarriages
Condition Parahttps://fhir.netsmartcloud.com/v4/StructureDefinition/condition-para
Condition Prenatal Care Another Facility Datehttps://fhir.netsmartcloud.com/v4/StructureDefinition/condition-prenatal-care-another-facility-date
Condition Received HPV Vaccinehttps://fhir.netsmartcloud.com/v4/StructureDefinition/condition-received-hpv-vaccine
Condition Sexually Active Codehttps://fhir.netsmartcloud.com/v4/StructureDefinition/condition-sexually-active-code
Condition Status Codehttps://fhir.netsmartcloud.com/v4/StructureDefinition/condition-status-code
Condition Treated For STD Codehttps://fhir.netsmartcloud.com/v4/StructureDefinition/condition-treated-for-std-code

Coverage

NameURI
Coverage Addresshttps://fhir.netsmartcloud.com/v4/StructureDefinition/coverage-address
Coverage Aid Codehttps://fhir.netsmartcloud.com/v4/StructureDefinition/coverage-aid-code
Coverage Bill Orderhttps://fhir.netsmartcloud.com/v4/StructureDefinition/coverage-bill-order
Coverage Birth Datehttps://fhir.netsmartcloud.com/v4/StructureDefinition/coverage-birth-date
Coverage Effective Date Of Contracthttps://fhir.netsmartcloud.com/v4/StructureDefinition/coverage-effective-date-of-contract
Coverage Effective Date of Medi-Cal Eligibilityhttps://fhir.netsmartcloud.com/v4/StructureDefinition/coverage-effective-date-of-medi-cal-eligibility
Coverage Eligibility Codehttps://fhir.netsmartcloud.com/v4/StructureDefinition/coverage-eligibility-code
Coverage Encounter Referencehttps://fhir.netsmartcloud.com/v4/StructureDefinition/coverage-encounterReference
Coverage Genderhttps://fhir.netsmartcloud.com/v4/StructureDefinition/coverage-gender
Coverage Guarantorhttps://fhir.netsmartcloud.com/v4/StructureDefinition/coverage-guarantor
Coverage Notehttps://fhir.netsmartcloud.com/v4/StructureDefinition/coverage-note
Coverage Relationship Codehttps://fhir.netsmartcloud.com/v4/StructureDefinition/coverage-relationship-code
Coverage Social Security Numberhttps://fhir.netsmartcloud.com/v4/StructureDefinition/coverage-social-security-number
Coverage Subscriber Meds ID Numberhttps://fhir.netsmartcloud.com/v4/StructureDefinition/coverage-subscriber-meds-id-number
Coverage Subscriber Namehttps://fhir.netsmartcloud.com/v4/StructureDefinition/coverage-subscriber-name
Coverage Subscriber Phone Numberhttps://fhir.netsmartcloud.com/v4/StructureDefinition/coverage-subscriber-phone-number
Coverage Subscriber Release Of Informationhttps://fhir.netsmartcloud.com/v4/StructureDefinition/coverage-subscriber-release-of-information

CoverageEligibilityRequest

NameURI
CoverageEligibilityRequest Benefit Planhttps://fhir.netsmartcloud.com/v4/StructureDefinition/coverageEligibilityRequest-benefit-plan
CoverageEligibilityRequest Custom Status Codehttps://fhir.netsmartcloud.com/v4/StructureDefinition/coverageEligibilityRequest-custom-status-code
CoverageEligibilityRequest Encounterhttps://fhir.netsmartcloud.com/v4/StructureDefinition/coverageEligibilityRequest-encounterReference
CoverageEligibilityRequest Funding Sourcehttps://fhir.netsmartcloud.com/v4/StructureDefinition/coverageEligibilityRequest-funding-source
CoverageEligibilityRequest Program Codehttps://fhir.netsmartcloud.com/v4/StructureDefinition/coverageEligibilityRequest-programCode

CoverageEligibilityResponse

NameURI
CoverageEligibilityResponse Benefit Planhttps://fhir.netsmartcloud.com/v4/StructureDefinition/coverageEligibilityResponse-benefit-plan
CoverageEligibilityResponse Custom Status Codehttps://fhir.netsmartcloud.com/v4/StructureDefinition/coverageEligibilityResponse-custom-status-code
CoverageEligibilityResponse Encounterhttps://fhir.netsmartcloud.com/v4/StructureDefinition/coverageEligibilityResponse-encounterReference
CoverageEligibilityResponse Funding Sourcehttps://fhir.netsmartcloud.com/v4/StructureDefinition/coverageEligibilityResponse-funding-source
CoverageEligibilityResponse Program Codehttps://fhir.netsmartcloud.com/v4/StructureDefinition/coverageEligibilityResponse-programCode

Encounter

NameURI
Encounter Admission Department Time Outhttps://fhir.netsmartcloud.com/v4/StructureDefinition/encounter-admission-department-time-out
Encounter Admission Sourcehttps://fhir.netsmartcloud.com/v4/StructureDefinition/encounter-admissionSource
Encounter Charge Codehttps://fhir.netsmartcloud.com/v4/StructureDefinition/encounter-charge-code
Encounter Clinical Summaryhttps://fhir.netsmartcloud.com/v4/StructureDefinition/encounter-clinical-summary
Encounter Discharge Alert Codehttps://fhir.netsmartcloud.com/v4/StructureDefinition/encounter-discharge-alert-code
Encounter Discharge Commentshttps://fhir.netsmartcloud.com/v4/StructureDefinition/encounter-dischargeComments
Encounter Discharge Legal Statushttps://fhir.netsmartcloud.com/v4/StructureDefinition/encounter-dischargeLegalStatus
Encounter Discharge Patient Statushttps://fhir.netsmartcloud.com/v4/StructureDefinition/encounter-dischargePatientStatus
Encounter Disposition Codehttps://fhir.netsmartcloud.com/v4/StructureDefinition/encounter-disposition-code
Encounter Homeless Indicator Codehttps://fhir.netsmartcloud.com/v4/StructureDefinition/encounter-homeless-indicator-code
Encounter Hospital Service Referencehttps://fhir.netsmartcloud.com/v4/StructureDefinition/encounter-hospitalServiceReference
Encounter Housing Situationhttps://fhir.netsmartcloud.com/v4/StructureDefinition/encounter-housingSituation
Encounter Is Immunization Record Requestedhttps://fhir.netsmartcloud.com/v4/StructureDefinition/encounter-is-immunization-record-requested
Encounter Is Informed of Smoking Policyhttps://fhir.netsmartcloud.com/v4/StructureDefinition/encounter-is-informed-of-smoking-policy
Encounter Is Perform Discharge Alerthttps://fhir.netsmartcloud.com/v4/StructureDefinition/encounter-is-perform-discharge-alert
Encounter Is Prescreenedhttps://fhir.netsmartcloud.com/v4/StructureDefinition/encounter-is-prescreened
Encounter Is School Record Requestedhttps://fhir.netsmartcloud.com/v4/StructureDefinition/encounter-is-school-record-requested
Encounter Military Servicehttps://fhir.netsmartcloud.com/v4/StructureDefinition/encounter-military-service
Encounter Notehttps://fhir.netsmartcloud.com/v4/StructureDefinition/encounter-note
Encounter Number of People Living in Householdhttps://fhir.netsmartcloud.com/v4/StructureDefinition/encounter-number-of-people-living-in-household
Encounter Practitioner Type codehttps://fhir.netsmartcloud.com/v4/StructureDefinition/encounter-practitioner-type-code
Encounter Partial Hospitalizationhttps://fhir.netsmartcloud.com/v4/StructureDefinition/encounter-partial-hospitalization
Encounter Prescreened Byhttps://fhir.netsmartcloud.com/v4/StructureDefinition/encounter-prescreened-by

Observation

NameURI
Observation Smoking Status Namehttps://fhir.netsmartcloud.com/v4/StructureDefinition/observation-smokingStatusName

Patient

NameURI
Patient Citizenshiphttp://hl7.org/fhir/StructureDefinition/patient-citizenship
Patient Communication Preferencehttps://fhir.netsmartcloud.com/v4/StructureDefinition/patient-communication-preference
Patient Custom Ethnicityhttps://fhir.netsmartcloud.com/v4/StructureDefinition/patient-custom-ethnicity
Patient Custom Racehttps://fhir.netsmartcloud.com/v4/StructureDefinition/patient-custom-race
Patient Education Levelhttps://fhir.netsmartcloud.com/v4/StructureDefinition/patient-educationLevel
Patient Employment Statushttps://fhir.netsmartcloud.com/v4/StructureDefinition/patient-employmentStatus
Patient English Proficiencyhttps://fhir.netsmartcloud.com/v4/StructureDefinition/patient-english-proficiency
Patient Family Incomehttps://fhir.netsmartcloud.com/v4/StructureDefinition/patient-family-income
Patient Family Sizehttps://fhir.netsmartcloud.com/v4/StructureDefinition/patient-family-size
Patient Gender Identityhttp://hl7.org/fhir/StructureDefinition/patient-genderIdentity
Patient Gender Identity Otherhttps://fhir.netsmartcloud.com/v4/StructureDefinition/patient-genderIdentity-other
Patient Housing Situationhttps://fhir.netsmartcloud.com/v4/StructureDefinition/patient-housingSituation
Patient Other Ethnic Originshttps://fhir.netsmartcloud.com/v4/StructureDefinition/patient-other-ethnic-origins
Patient Preferred Provider Ethnic Originhttps://fhir.netsmartcloud.com/v4/StructureDefinition/patient-preferred-provider-ethnic-origins
Patient Preferred Provider Genderhttps://fhir.netsmartcloud.com/v4/StructureDefinition/patient-preferred-provider-gender
Patient Sexual Orientationhttps://fhir.netsmartcloud.com/v4/StructureDefinition/patient-sexualOrientation
Patient Sexual Orientation Otherhttps://fhir.netsmartcloud.com/v4/StructureDefinition/patient-sexualOrientation-other
Patient Veteran Statushttps://fhir.netsmartcloud.com/v4/StructureDefinition/patient-veteran-status
US Core Birth Sexhttp://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
US Core Ethnicityhttp://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
US Core Gender Identityhttp://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
US Core Racehttp://hl7.org/fhir/us/core/StructureDefinition/us-core-race

Procedure

NameURI
Procedure Pertaining to Event IDhttps://fhir.netsmartcloud.com/v4/StructureDefinition/procedure-pertainingToEventID

Extension Usage Guidelines

Implementation Notes

  • Extensions are defined using StructureDefinition resources
  • All Netsmart-specific extensions use the base URL: https://fhir.netsmartcloud.com/v4/StructureDefinition/
  • Standard HL7 and US Core extensions maintain their original URLs
  • Extension support may vary by tenant configuration

Validation Requirements

Before implementing extensions in your application:

  1. Retrieve CapabilityStatement - Always get the current CapabilityStatement from /metadata
  2. Validate Extension Support - Check that required extensions are listed in the CapabilityStatement
  3. Test Implementation - Verify extension usage with actual API calls
  4. Monitor Changes - Extensions may be added or deprecated with API updates

Error Handling

For information about error responses when working with extensions, see Common Errors.

Common extension-related errors include:

  • Invalid extension URLs
  • Unsupported extensions for specific resources
  • Malformed extension values
  • Missing required extension elements

Support

For questions about extension support or implementation, contact Netsmart support through your designated support channels.