HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.2 - STU 2 United States of America flag

HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.1.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/case-reporting/ and changes regularly. See the Directory of published versions

Resource Profile: US Public Health Patient

Official URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-patient Version: 2.1.2
Active as of 2024-10-30 Computable Name: USPublicHealthPatient
Other Identifiers: OID:2.16.840.1.113883.4.642.40.46.42.62

This Patient profile represents a US Public Health Patient.

It is based on the US Core Patient profile with further constraints to require and/or allow masking of some data elements, and the addition of the US Public Health Gender Identity extension.

For ONC’s USCDI requirements, it also adds Must Support constraints to the following:

  • contact detail (e.g. a telephone number or an email address)
  • a communication language
  • a race
  • an ethnicity
  • a birth sex

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from USCorePatientProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* USCorePatientProfile(4.0.0) US Public Health Patient
... Slices for extension Content/Rules for all slices
.... extension:race S 1..1 USCoreRaceExtension(4.0.0) US Core Race Extension
..... Slices for extension Content/Rules for all slices
...... dataAbsentReason S 0..1 (Complex) For masking purposes, use the data-absent-reason extension and set the required us-core-race extension text to "masked"
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
....... value[x] S 1..1 code Value of extension
Fixed Value: masked
.... extension:ethnicity S 1..1 USCoreEthnicityExtension(4.0.0) US Core ethnicity Extension
..... Slices for extension Content/Rules for all slices
...... dataAbsentReason S 0..1 (Complex) For masking purposes, use the data-absent-reason extension and set the required us-core-ethnicity extension text to "masked"
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
....... value[x] S 1..1 code Value of extension
Fixed Value: masked
.... extension:birthsex S 0..1 USCoreBirthSexExtension(4.0.0) Extension
.... birthPlace S 0..1 Address Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... genderIdentity S 0..* (Complex) The individual's gender identity
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-genderidentity-extension
.... tribalAffiliation S 0..* (Complex) Tribal affiliation and membership of the patient
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-tribal-affiliation-extension
... identifier S 1..* Identifier An identifier for this patient
.... Slices for extension Content/Rules for all slices
..... dataAbsentReason 0..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
...... value[x] S 1..1 code Value of extension
Fixed Value: masked
... name 1..* HumanName A name associated with the patient
.... Slices for extension Content/Rules for all slices
..... dataAbsentReason S 0..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
...... value[x] S 1..1 code Value of extension
Fixed Value: masked
.... telecom:All Slices Content/Rules for all slices
..... Slices for extension Content/Rules for all slices
...... dataAbsentReason S 0..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
....... value[x] S 1..1 code Value of extension
Fixed Value: masked
.... telecom:phone S 0..* ContactPoint A contact detail for the individual
..... system S 1..1 code phone | fax | email | pager | url | sms | other
Fixed Value: phone
.... telecom:email S 0..* ContactPoint A contact detail for the individual
..... system S 1..1 code phone | fax | email | pager | url | sms | other
Fixed Value: email
... gender S 1..1 code male | female | other | unknown
.... Slices for extension Content/Rules for all slices
..... dataAbsentReason S 0..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
...... value[x] S 1..1 code Value of extension
Fixed Value: masked
... birthDate S 1..1 date The date of birth for the individual
.... Slices for extension Content/Rules for all slices
..... dataAbsentReason S 0..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
...... value[x] S 1..1 code Value of extension
Fixed Value: masked
... deceased[x] S 1..1 boolean, dateTime If patient is deceased, use type dateTime and set to deceased date.
... address S 1..* Address An address for the individual
.... Slices for extension Content/Rules for all slices
..... dataAbsentReason S 0..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
...... value[x] S 1..1 code Value of extension
Fixed Value: masked
.... district S 0..1 string County
... contact S 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
.... relationship S 1..1 CodeableConcept The kind of relationship
.... name S 1..1 HumanName A name associated with the contact person
..... Slices for extension Content/Rules for all slices
...... dataAbsentReason S 0..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
....... value[x] S 1..1 code Value of extension
Fixed Value: masked
.... telecom S 1..* ContactPoint A contact detail for the person
..... Slices for extension Content/Rules for all slices
...... dataAbsentReason S 0..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
....... value[x] S 1..1 code Value of extension
Fixed Value: masked
.... address S 1..1 Address Address for the contact person
..... Slices for extension Content/Rules for all slices
...... dataAbsentReason S 0..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
....... value[x] S 1..1 code Value of extension
Fixed Value: masked
... communication S 1..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
..... Slices for extension Content/Rules for all slices
...... dataAbsentReason S 0..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
....... value[x] S 1..1 code Value of extension
Fixed Value: masked

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron