Structure Definition: Patient Profile


Canonical URL: https://signalbhn.org/fhir/StructureDefinition/patient

Simplifier project page: Patient

Derived from: US Core Patient STU6 (R4)

Module: Patient Administration Module


Formal profile content

raceI0..1Extension(Complex)
ethnicityI0..1Extension(Complex)
tribalAffiliationI0..*Extension(Complex)
birthsexI0..1Extension(code)
genderIdentityI0..*Extension(CodeableConcept)
adoptionInfoI0..1Extension(CodeableConcept)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uri
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
useΣ ?!0..1codeBinding
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1stringFixed Value
systemS Σ1..1uriFixed Value
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
useΣ ?!0..1codeBinding
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1stringFixed Value
systemS Σ1..1uriFixed Value
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
useΣ ?!0..1codeBinding
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1stringFixed Value
systemS Σ1..1uriFixed Value
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
useΣ ?!0..1codeBinding
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
systemS Σ1..1uri
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
useΣ ?!0..1codeBinding
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
systemS Σ1..1uriFixed Value
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
activeΣ ?!0..1boolean
useΣ ?!0..1codeBinding
textΣ0..1string
familyS Σ I0..1string
givenS Σ I0..*string
prefixΣ0..*string
suffixΣ0..*string
periodΣ I0..1Period
systemS Σ I1..1codeBinding
valueS Σ1..1string
useS Σ ?!0..1codeBinding
rankΣ0..1positiveInt
periodΣ I0..1Period
genderS Σ1..1codeBinding
birthDateS Σ0..1date
deceasedBooleanboolean
deceasedDateTimedateTime
noFixedAddressI0..1Extension(boolean)
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textΣ0..1string
lineS Σ0..*string
cityS Σ0..1string
districtΣ0..1stringBinding
stateS Σ0..1stringBinding
postalCodeS Σ0..1string
countryΣ0..1string
periodΣ I0..1Period
maritalStatus0..1CodeableConceptBinding
multipleBirthBooleanboolean
multipleBirthIntegerinteger
photoI0..*Attachment
relationship0..*CodeableConceptBinding
name0..1HumanName
telecomI0..*ContactPoint
address0..1Address
gender0..1codeBinding
organizationI0..1Reference(Organization)
periodI0..1Period
languageS1..1CodeableConceptBinding
preferred0..1boolean
generalPractitionerI0..*Reference(Organization | Practitioner | PractitionerRole)
managingOrganizationΣ I0..1Reference(Organization)
otherΣ I1..1Reference(Patient | RelatedPerson)
typeΣ1..1codeBinding
raceI0..1Extension(Complex)
ethnicityI0..1Extension(Complex)
tribalAffiliationI0..*Extension(Complex)
birthsexI0..1Extension(code)
genderIdentityI0..*Extension(CodeableConcept)
adoptionInfoI0..1Extension(CodeableConcept)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uri
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
useΣ ?!0..1codeBinding
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1stringFixed Value
systemS Σ1..1uriFixed Value
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
useΣ ?!0..1codeBinding
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1stringFixed Value
systemS Σ1..1uriFixed Value
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
useΣ ?!0..1codeBinding
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1stringFixed Value
systemS Σ1..1uriFixed Value
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
useΣ ?!0..1codeBinding
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
systemS Σ1..1uri
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
useΣ ?!0..1codeBinding
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
systemS Σ1..1uriFixed Value
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
activeΣ ?!0..1boolean
useΣ ?!0..1codeBinding
textΣ0..1string
familyS Σ I0..1string
givenS Σ I0..*string
prefixΣ0..*string
suffixΣ0..*string
periodΣ I0..1Period
systemS Σ I1..1codeBinding
valueS Σ1..1string
useS Σ ?!0..1codeBinding
rankΣ0..1positiveInt
periodΣ I0..1Period
genderS Σ1..1codeBinding
birthDateS Σ0..1date
deceasedBooleanboolean
deceasedDateTimedateTime
noFixedAddressI0..1Extension(boolean)
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textΣ0..1string
lineS Σ0..*string
cityS Σ0..1string
districtΣ0..1stringBinding
stateS Σ0..1stringBinding
postalCodeS Σ0..1string
countryΣ0..1string
periodΣ I0..1Period
maritalStatus0..1CodeableConceptBinding
multipleBirthBooleanboolean
multipleBirthIntegerinteger
photoI0..*Attachment
relationship0..*CodeableConceptBinding
name0..1HumanName
telecomI0..*ContactPoint
address0..1Address
gender0..1codeBinding
organizationI0..1Reference(Organization)
periodI0..1Period
languageS1..1CodeableConceptBinding
preferred0..1boolean
generalPractitionerI0..*Reference(Organization | Practitioner | PractitionerRole)
managingOrganizationΣ I0..1Reference(Organization)
otherΣ I1..1Reference(Patient | RelatedPerson)
typeΣ1..1codeBinding
{
    "resourceType": "StructureDefinition",
    "id": "signal-patient",
    "url": "http://signalbhn.org/fhir/StructureDefinition/patient",
    "name": "SignalPatient",
    "title": "Patient Profile",
    "status": "draft",
    "date": "2023-06-15T17:41:33.182674+00:00",
    "description": "Constraints and extensions on the US Core Patient Resource",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Patient",
    "baseDefinition": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Patient.extension:adoptionInfo",
                "path": "Patient.extension",
                "sliceName": "adoptionInfo",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://hl7.org/fhir/StructureDefinition/patient-adoptionInfo"
                        ]
                    }
                ],
                "isModifier": false
            },
            {
                "id": "Patient.identifier",
                "path": "Patient.identifier",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "system"
                        }
                    ],
                    "rules": "open"
                }
            },
            {
                "id": "Patient.identifier:SSN",
                "path": "Patient.identifier",
                "sliceName": "SSN",
                "short": "SSN Identifier for this patient",
                "definition": "SSN identifier for this patient."
            },
            {
                "id": "Patient.identifier:SSN.type.coding.system",
                "path": "Patient.identifier.type.coding.system",
                "fixedUri": "https://www.hl7.org/fhir/valueset-identifier-type.html"
            },
            {
                "id": "Patient.identifier:SSN.type.coding.code",
                "path": "Patient.identifier.type.coding.code",
                "fixedCode": "SB"
            },
            {
                "id": "Patient.identifier:SSN.type.coding.display",
                "path": "Patient.identifier.type.coding.display",
                "fixedString": "Social Beneficiary Identifier"
            },
            {
                "id": "Patient.identifier:SSN.type.text",
                "path": "Patient.identifier.type.text",
                "fixedString": "Social Security Number"
            },
            {
                "id": "Patient.identifier:SSN.system",
                "path": "Patient.identifier.system",
                "fixedUri": "http://hl7.org/fhir/sid/us-ssn"
            },
            {
                "id": "Patient.identifier:MedicaidID",
                "path": "Patient.identifier",
                "sliceName": "MedicaidID",
                "short": "Medicaid identifier for this patient",
                "definition": "Medicaid identifier for this patient."
            },
            {
                "id": "Patient.identifier:MedicaidID.type.coding.system",
                "path": "Patient.identifier.type.coding.system",
                "fixedUri": "https://www.hl7.org/fhir/valueset-identifier-type.html"
            },
            {
                "id": "Patient.identifier:MedicaidID.type.coding.code",
                "path": "Patient.identifier.type.coding.code",
                "fixedCode": "SB"
            },
            {
                "id": "Patient.identifier:MedicaidID.type.coding.display",
                "path": "Patient.identifier.type.coding.display",
                "fixedString": "Social Beneficiary Identifier"
            },
            {
                "id": "Patient.identifier:MedicaidID.type.text",
                "path": "Patient.identifier.type.text",
                "fixedString": "Patient Medicaid number"
            },
            {
                "id": "Patient.identifier:MedicaidID.system",
                "path": "Patient.identifier.system",
                "fixedUri": "https://signalbhn.org/fhir/sid/us-medicaidid"
            },
            {
                "id": "Patient.identifier:MedicareID",
                "path": "Patient.identifier",
                "sliceName": "MedicareID",
                "short": "Medicare identifier for this patient",
                "definition": "Medicare identifier for this patient."
            },
            {
                "id": "Patient.identifier:MedicareID.type.coding.system",
                "path": "Patient.identifier.type.coding.system",
                "fixedUri": "https://www.hl7.org/fhir/valueset-identifier-type.html"
            },
            {
                "id": "Patient.identifier:MedicareID.type.coding.code",
                "path": "Patient.identifier.type.coding.code",
                "fixedCode": "SB"
            },
            {
                "id": "Patient.identifier:MedicareID.type.coding.display",
                "path": "Patient.identifier.type.coding.display",
                "fixedString": "Social Beneficiary Identifier"
            },
            {
                "id": "Patient.identifier:MedicareID.type.text",
                "path": "Patient.identifier.type.text",
                "fixedString": "Patient Unique Medicare Number"
            },
            {
                "id": "Patient.identifier:MedicareID.system",
                "path": "Patient.identifier.system",
                "fixedUri": "http://hl7.org/fhir/sid/us-mbi"
            },
            {
                "id": "Patient.identifier:ProviderClientId",
                "path": "Patient.identifier",
                "sliceName": "ProviderClientId",
                "short": "ProviderClient identifier for this patient",
                "definition": "ProviderClient identifier for this patient."
            },
            {
                "id": "Patient.identifier:ProviderClientId.type.coding.system",
                "path": "Patient.identifier.type.coding.system",
                "fixedUri": "https://www.hl7.org/fhir/valueset-identifier-type.html"
            },
            {
                "id": "Patient.identifier:ProviderClientId.type.coding.code",
                "path": "Patient.identifier.type.coding.code",
                "fixedCode": "MR"
            },
            {
                "id": "Patient.identifier:ProviderClientId.type.coding.display",
                "path": "Patient.identifier.type.coding.display",
                "fixedString": "Medical Record Number"
            },
            {
                "id": "Patient.identifier:ProviderClientId.system",
                "path": "Patient.identifier.system",
                "definition": "This needs to be the URL that is specific to the Provider's domain; e.g. http://example.org"
            },
            {
                "id": "Patient.identifier:ClientId",
                "path": "Patient.identifier",
                "sliceName": "ClientId",
                "short": "Client identifier for this patient",
                "definition": "Signal's Beacon legacy identifier for client."
            },
            {
                "id": "Patient.identifier:ClientId.type.coding.system",
                "path": "Patient.identifier.type.coding.system",
                "fixedUri": "https://www.hl7.org/fhir/valueset-identifier-type.html"
            },
            {
                "id": "Patient.identifier:ClientId.type.coding.code",
                "path": "Patient.identifier.type.coding.code",
                "fixedCode": "MR"
            },
            {
                "id": "Patient.identifier:ClientId.type.coding.display",
                "path": "Patient.identifier.type.coding.display",
                "fixedString": "Medical Record Number"
            },
            {
                "id": "Patient.identifier:ClientId.system",
                "path": "Patient.identifier.system",
                "fixedUri": "https://signalbhn.org/fhir/sid/beacon-legacy"
            },
            {
                "id": "Patient.address.extension:noFixedAddress",
                "path": "Patient.address.extension",
                "sliceName": "noFixedAddress",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://hl7.org/fhir/StructureDefinition/no-fixed-address"
                        ]
                    }
                ],
                "isModifier": false
            },
            {
                "id": "Patient.address.district",
                "path": "Patient.address.district",
                "binding": {
                    "strength": "required",
                    "valueSet": "https://signalbhn.org/fhir/ValueSet/fips-county-co"
                }
            }
        ]
    }
}

Profile usage

The Patient resource is used to collect basic demographic and administrative information on individuals that are receiving one or more services. The profile is expected to comply with the US Core Patient Profile specifications, plus contains additional extensions and identifier slices specific for Signal.

Note there is no program, admission, encounter, or other provider interaction information contained on the Patient resource. Nor is there any insurance, coverage, or payment information directly on Patient. This resource only covers the "who" information about the patient.

The patient profile is designed to be specific to each provider organization utilizing the managingOrganization element. Multiple resources for an indiviaul may exist, and in this way, duplicate records for an individual are expected within this system across provider organizations.

Profile element notes

.managingOrganization

  • SHALL reference the provider agency from whom the patient record was entered
  • The patient record SHOULD be available to all locations in the Organization.partOf hierarchy

.identifier:SSN

  • Contains the Social Security Number for the patient, if available
  • Fixed values are created for the associated codeable concepts

.identifier:MedicaidID

  • Contains the Medicaid ID for the patient, if available
  • Fixed values are created for the associated codeable concepts
  • No assumption is made as to the state associated for the Medicaid ID; to accomodate this, .system is set as a fixed value to https://signalbhn.org/fhir/sid/us-medicaidid

.identifier:MedicareID

  • Contains the Medicaid ID for the patient, if available
  • Fixed values are created for the associated codeable concepts
  • Note, this includes only the Medicare ID, information on benefits is contained on the Coverage resource

.identifier:ProviderClientID

  • Contains any of the Provider's ID(s) for the patient
  • Note, the system element needs to be entered as the URL to that Provider's domain; e.g. https://example.org to be linked to the proper provider identity

.identifier:ClientID

  • Contains the carryover identifiers for the patient from Signal's Beacon system

.adoptionInfo (extension) - Patient.extension:adoptionInfo

  • Utilized for specific programs
  • If present, a fixed value representing the SNOWMED code for "Adopted" is supplied in the Extension.value[x]:valueCodeableConcept
  • Extension.value[x]:valueDate represents the adoption date and is required when adoption is used.

.address.noFixedAddress (extension) - Patient.address.extension:noFixedAddress

  • The No Fixed Address indictor, when present, will be assigned a fixed boolean value of true on Extension.value[x]:valueBoolean
  • The No Fixed Address indicator SHALL take priority for administrative purposes, even if some other address fields contain information

.address.district - Patient.address.district

  • Contains a ValueSet binding for Colorado counties using FIPs code plus Other

Examples