Patient

Base profile: https://hl7.org/fhir/R4/patient.html

Common Use Cases

  • Retrieve all patients for a specific practice
  • Search for a specific patient
  • Identify changes made within a given time frame
  • Retrieve a patient's demographic information
    Create a new patient record
  • Update an existing patient’s demographic details

Important Considerations

  • Patient Creation: If your application uses the Patient CREATE resource, the API will allow the creation of new patient records. Be mindful of avoiding duplicate entries for patients already in the system.
  • Patient Matching: To minimize duplicate patient records, ensure that your application at least matches on the following key identifiers:
    • First name
    • Last name
    • Date of birth (DOB)
    • Gender
      Additional recommended matching criteria include:
    • Email address
    • Phone number
    • Zip code
    • Social Security Number (SSN) (if applicable)

Data Format

  • All responses are returned in JSON by default. If you prefer XML, simply include the following parameter in your query:
    ?_format=application/fhir+xml

The following attributes are supported:

Field NameNotes
idThe MMI-specific unique identifier for the patient
identifierLists the various identifiers of a patient.
A patient may have one, many, or all of the following identifiers:
  • PMS : (Practice Management System ID) - Note: For practices using ModMed’s Practice Management System, this will be the MMI PMS ID. For practices using another Practice Management System, this will be the ID from that system.
  • MRN : https://hl7.org/fhir/R4/v2/0203/index.html#v2-0203-MR
  • SSN : http://hl7.org/fhir/sid/us-ssn**Note:**If you pass a header of ‘Content-Flag’ with a value of ‘Referral’ you can view this information (if it exists) for the Patient.
    • *Referral Source** : /fhir/v2/ValueSet/referral-source (populates only when Content-Flag: Referral is sent)
activetrue|false
name
  • family
  • given
telecomThe various contact methods for the patient. “rank” is used to determine the Patient’s preferred contact method.
genderThe Patient’s birth gender
birthDateThe Patient’s birth date
deceasedBooleantrue/false
addressThe Patient’s address(es)
maritalStatusThe Patient’s Marital Status - http://www.hl7.org/fhir/v2/0002/
contactEmergency Contact - http://www.hl7.org/fhir/v2/0131/
communicationLanguage - http://www.loc.gov/standards/iso639-2/php/code_list.php
extension - Racehttp://hl7.org/fhir/us/core/STU3.1/StructureDefinition-us-core-race.html
extension - Ethnicityhttp://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
generalPractitionerhttp://hl7.org/fhir/valueset-encounter-participant-type.html
MMI will support:
  • REF Referrer : This is typically a referring physician and will reference an NPI if there is one in the system
  • PPRF Primary Performer : This is typically the patient’s Primary Practitioner at the practice and
    will be a reference to the /Practitioner
    • *Note:**These are the values at the Patient level - meaning that these values are general. You may find different Primary and Referring practitioners at the Encounter level as many times those are specific to an individual encounter.**Note:** When Content-Flag: Referral is sent in the FHIR request, if the Patient has a ‘Referring Provider’, there will be a reference to a Practitioner within this field.
generalPractitioner extension - date last seenThe last visit date of the patient with the referenced provider. Added as an extension to the generalPractitioner field using a url of “date-last-seen”.
referral-sourceNote: When Content-Flag: Referral is sent in the FHIR request, if the Patient has a ‘Referral Source’, there will be a reference to a Practitioner within this field.
If the Patient has been assigned a Referral Source in MMPM, this will be a reference to that ID. Referral Sources can be found by querying the following Value Set: {baseurl}/{firm_url_prefix}/ema/fhir/v2/ValueSet/referral-source

Note: The Patient resource also supports the following extensions:

The Following Operations are supported:

  • Patient READ
  • Patient SEARCH
  • Patient CREATE
  • Patient UPDATE