The Patient resource implements the FHIR R4 Patient specification and US Core v3.1.1 Patient profile

Fields

Name Type Cardinality Required Description
identifier Identifier 0..*   An identifier for this patient
identifier.system uri 1..1 * The namespace for the identifier value
identifier.value string 1..1 * The value that is unique within the system.
active boolean 0..1   Whether this patient’s record is in active use
name HumanName 1..* * A name associated with the patient
name.use code 0..1   usual | official | temp | nickname | anonymous | old | maiden
name.family string 0..1   Family name (often called ‘Surname’)
name.given string 0..*   Given names (not always ‘first’). Includes middle names
name.prefix string 0..*   Parts that come before the name
name.suffix string 0..*   Parts that come after the name
name.period Period 0..*   Time period when name was/is in use
telecom ContactPoint 0..*   A contact detail for the individual
telecom.system code 1..1 * phone | fax | email | pager | url | sms | other
telecom.value string 1..1 * The actual contact point details
telecom.use code 0..1   home | work | temp | old | mobile - purpose of this contact point
gender code 1..1 * male | female | other | unknown
birthDate date 0..1   The date of birth for the individual
deceasedBoolean boolean 0..1   Indicates if the individual is deceased or not
deceasedDateTime dateTime 0..1   Indicates if the individual is deceased or not
address Address 0..*   Addresses for the individual
address.line string 0..*   Street name, number, direction & P.O. Box etc.
address.city string 0..1   Name of city, town etc.
address.state string 0..1   Sub-unit of country (abbreviations ok) - Binding
address.postalCode string 0..1 US Zip Codes  
address.country string 0..1   Country (e.g. can be ISO 3166 2 or 3 letter code)
address.period Period 0..1   Time period when address was/is in use
maritalStatus CodeableConcept 0..1   Marital (civil) status of a patient
multipleBirthBoolean boolean 0..1   Whether patient is part of a multiple birth
multipleBirthInteger integer 0..1   Whether patient is part of a multiple birth
photo Attachment 0..*   Image of the patient
contact BackboneElement 0..*   A contact party (e.g. guardian, partner, friend) for the patient
communication BackboneElement 0..*   A list of Languages which may be used to communicate with the patient about his or her health
communication.language CodeableConcept 1..1 * The language which can be used to communicate with the patient about his or her health - Binding
generalPractitioner Reference 0..*   Patient’s nominated primary care provider
managingOrganization Reference 0..1   Organization that is the custodian of the patient record
link BackboneElement 0..*   Link to another patient resource that concerns the same actual person

Interactions

Read

Get an Patient entry by id

GET /Patient/:id

Example

Request

https://r4cert.medicasoft.us/api/fhir/Patient/bcfa83df-ee8c-9721-cc07-bdcfc2b1e3f2

Response

{
  "resourceType": "Patient",
  "extension": [
    {
      "extension": [
        {
          "url": "ombCategory",
          "valueCoding": {
            "system": "urn:oid:2.16.840.1.113883.6.238",
            "code": "2106-3",
            "display": "White"
          }
        },
        {
          "url": "text",
          "valueString": "White"
        }
      ],
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
    },
    {
      "extension": [
        {
          "url": "ombCategory",
          "valueCoding": {
            "system": "urn:oid:2.16.840.1.113883.6.238",
            "code": "2186-5",
            "display": "Non Hispanic or Latino"
          }
        },
        {
          "url": "text",
          "valueString": "Non Hispanic or Latino"
        }
      ],
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName",
      "valueString": "Era940 Lakin515"
    },
    {
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
      "valueCode": "M"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/patient-birthPlace",
      "valueAddress": {
        "city": "Brockton",
        "state": "Massachusetts",
        "country": "US"
      }
    }
  ],
  "identifier": [
    {
      "value": "bcfa83df-ee8c-9721-cc07-bdcfc2b1e3f2",
      "system": "https://github.com/synthetichealth/synthea"
    },
    {
      "value": "bcfa83df-ee8c-9721-cc07-bdcfc2b1e3f2",
      "system": "http://hospital.smarthealthit.org"
    },
    {
      "value": "999-34-7109",
      "system": "http://hl7.org/fhir/sid/us-ssn"
    },
    {
      "value": "S99973067",
      "system": "https://r4cert.medicasoft.us/api/urn:oid:2.16.840.1.113883.4.3.25"
    }
  ],
  "name": [
    {
      "use": "official",
      "family": "Veum823",
      "given": [
        "Walton167"
      ],
      "prefix": [
        "Mr."
      ]
    }
  ],
  "telecom": [
    {
      "system": "phone",
      "value": "555-207-9777",
      "use": "home"
    }
  ],
  "gender": "male",
  "birthDate": "1941-12-23",
  "deceasedDateTime": "1995-07-09T03:47:44-04:00",
  "address": [
    {
      "extension": [
        {
          "extension": [
            {
              "url": "latitude",
              "valueDecimal": 41.97099287542957
            },
            {
              "url": "longitude",
              "valueDecimal": -70.70929495069497
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/geolocation"
        }
      ],
      "line": [
        "1025 Gutkowski Brook Apt 78"
      ],
      "city": "Kingston",
      "state": "MA",
      "country": "US",
      "period": {
        "start": "1941-12-23"
      },
      "postalCode": "02364"
    }
  ],
  "maritalStatus": {
    "coding": [
      {
        "code": "M",
        "system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
        "display": "M"
      }
    ],
    "text": "M"
  },
  "multipleBirthBoolean": false,
  "communication": [
    {
      "language": {
        "coding": [
          {
            "code": "en-US",
            "system": "urn:ietf:bcp:47",
            "display": "English"
          }
        ],
        "text": "English"
      },
      "preferred": true
    }
  ],
  "id": "bcfa83df-ee8c-9721-cc07-bdcfc2b1e3f2"
}

Query Patient resources

GET /Patient?:query_parameters

Parameters

Name Type Description
_id reference Patient id
active token Whether the patient record is active
address string A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text
birthdate date The patient’s date of birth
death-date date The date of death has been provided and satisfies this search value
deceased token This patient has been marked as deceased, or as a death date entered
family string A portion of the family name of the patient
gender token Gender of the patient
given string A portion of the given name of the patient
identifier token A patient identifier
language token Language code (irrespective of use value)
link reference All patients linked to the given patient
name string A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
telecom token The value in any kind of telecom details of the patient
_revinclude   Provenance:target

Errors

Code Description
400 Invalid parameters
404 Resource not found

Profiles

The NXT platform supports the US Core Patient profile:

  • name field is required, all HumanName fields are supported, including suffix, use and period. Previous names are supported.
  • identifier must have at least one value, the Medical Record Number (MRN)
  • gender is required
  • telecom is supported and all ContactPoint fields are supported
  • birthDate is supported
  • address is aupported and all Address fields are supported, including period
  • communication is supported

  • the US Core Race Extension is supported: extension.url="http://hl7.org/fhir/us/core/StructureDefinition/us-core-race" extension.extension[0].url="ombCategory" extension.extension[0].valueCoding=<coding> - Binding extension.extension[1].url="detailed| extension.extension[1].valueCoding=<coding> - Binding extension.extension[2].url="text" extension.extension[2].valueString=<race_text>

    Example

    {
   "extension": [
     {
       "url": "ombCategory",
       "valueCoding": {
         "system": "urn:oid:2.16.840.1.113883.6.238",
         "code": "2106-3",
         "display": "White"
       }
     },
     {
       "url": "text",
       "valueString": "White"
     }
   ],
   "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
 },
 {
   "extension": [
     {
       "url": "ombCategory",
       "valueCoding": {
         "system": "urn:oid:2.16.840.1.113883.6.238",
         "code": "2186-5",
         "display": "Non Hispanic or Latino"
       }
     },
     {
       "url": "text",
       "valueString": "Non Hispanic or Latino"
     }
   ],
   "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
 }

  • the US Core ethnicity Extension is supported: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity" extension.extension[0].url="ombCategory" extension.extension[0].valueCoding=<coding> - Binding extension.extension[1].url="detailed| extension.extension[1].valueCoding=<coding> - Binding extension.extension[2].url="text" extension.extension[2].valueString=<ethnicity_text>

    Example

        {
 "extension": [
     {
       "url": "ombCategory",
       "valueCoding": {
         "system": "urn:oid:2.16.840.1.113883.6.238",
         "code": "2186-5",
         "display": "Non Hispanic or Latino"
       }
     },
     {
       "url": "text",
       "valueString": "Non Hispanic or Latino"
     }
   ],
   "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
 }

  • the US Core BirthSex extension is supported: extension.url="http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex" extension.valueCode=<code> - M | F | UNK - Binding

    Example

     {
   "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
   "valueCode": "M"
 }