US Public Health Profiles Library
1.0.0 - STU1 United States of America flag

US Public Health Profiles Library, published by HL7 Public Health Working Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/fhir-us-ph-library/ and changes regularly. See the Directory of published versions

Resource Profile: US Public Health Patient

Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-patient Version: 1.0.0
Active as of 2023-08-16 Computable Name: USPublicHealthPatient

This Patient profile represents a US Public Health Patient.

It is based on the US Core Patient profile and further constrains it as follows:

  • allows masking of some data elements using the FHIR data-absent-reason extension
  • adds Must Support constraints to the following data elements from ONC’s USCDI V2 Patient Demographics Data Class:
    • contact detail (e.g. a telephone number or an email address)
    • a communication language
    • a race
    • an ethnicity
    • a birth sex
  • adds the US Public Health Gender Identity extension (this is different to the Gender Identity extension used in US Core due to the issue raised here: https://jira.hl7.org/browse/FHIR-37509)
  • adds the following extensions:
    • birthPlace
    • tribalAffiliation
  • adds contact

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..*USCorePatientProfileInformation about an individual or animal receiving health care services
... extension 2..*ExtensionExtension
... extension:race S1..1USCoreRaceExtensionUS Core Race Extension
.... extension 1..*ExtensionExtension
.... dataAbsentReason S0..1codeFor 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
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

..... value[x] S1..1codeValue of extension
Fixed Value: masked
... extension:ethnicity S1..1USCoreEthnicityExtensionUS Core ethnicity Extension
.... extension 1..*ExtensionExtension
.... dataAbsentReason S0..1codeFor 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
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

..... value[x] S1..1codeValue of extension
Fixed Value: masked
... birthPlace S0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... individualGenderIdentity S0..*(Complex)The individual's gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
... tribalAffiliation S0..*(Complex)Tribal affiliation and membership of the patient
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-tribal-affiliation-extension
... identifier
.... dataAbsentReason 0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

..... value[x] S1..1codeValue of extension
Fixed Value: masked
... name
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

..... value[x] S1..1codeValue of extension
Fixed Value: masked
... Slices for telecom S1..*ContactPointA contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:All Slices Content/Rules for all slices
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

...... value[x] S1..1codeValue of extension
Fixed Value: masked
.... telecom:phone S0..*ContactPointA contact detail for the individual
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

..... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: phone
.... telecom:email S0..*ContactPointA contact detail for the individual
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

..... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: email
... gender
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

..... value[x] S1..1codeValue of extension
Fixed Value: masked
... birthDate 1..1dateThe date of birth for the individual
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

..... value[x] S1..1codeValue of extension
Fixed Value: masked
... deceased[x] S1..1boolean, dateTimeIf patient is deceased, use type dateTime and set to deceased date.
... address 1..*AddressAn address for the individual
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

..... value[x] S1..1codeValue of extension
Fixed Value: masked
.... district S0..1stringCounty
... contact S0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... relationship S1..1CodeableConceptThe kind of relationship
.... name S1..1HumanNameA name associated with the contact person
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

...... value[x] S1..1codeValue of extension
Fixed Value: masked
.... telecom S1..*ContactPointA contact detail for the person
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

...... value[x] S1..1codeValue of extension
Fixed Value: masked
.... address S1..1AddressAddress for the contact person
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

...... value[x] S1..1codeValue of extension
Fixed Value: masked
... communication S1..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... language
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

...... value[x] S1..1codeValue of extension
Fixed Value: masked

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*USCorePatientProfileInformation about an individual or animal receiving health care services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... race S1..1(Complex)US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:ombCategory S0..5ExtensionAmerican Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
..... url 1..1uri"ombCategory"
..... value[x] 1..1CodingValue of extension
Binding: OMB Race Categories (required): The 5 race category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997.

.... extension:detailed 0..*ExtensionExtended race codes
..... url 1..1uri"detailed"
..... value[x] 1..1CodingValue of extension
Binding: Detailed Race (required)
.... extension:text S1..1ExtensionRace Text
..... url 1..1uri"text"
..... value[x] 1..1stringValue of extension
.... dataAbsentReason S0..1codeFor 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
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


Fixed Value: masked
.... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:ombCategory S0..1ExtensionHispanic or Latino|Not Hispanic or Latino
..... url 1..1uri"ombCategory"
..... value[x] 1..1CodingValue of extension
Binding: OMB Ethnicity Categories (required)
.... extension:detailed 0..*ExtensionExtended ethnicity codes
..... url 1..1uri"detailed"
..... value[x] 1..1CodingValue of extension
Binding: Detailed ethnicity (required)
.... extension:text S1..1Extensionethnicity Text
..... url 1..1uri"text"
..... value[x] 1..1stringValue of extension
.... dataAbsentReason S0..1codeFor 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
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


Fixed Value: masked
.... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
... birthsex S0..1codeExtension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth


... genderIdentity 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity (extensible)
... birthPlace S0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... individualGenderIdentity S0..*(Complex)The individual's gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
... tribalAffiliation S0..*(Complex)Tribal affiliation and membership of the patient
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-tribal-affiliation-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..*IdentifierAn identifier for this patient
.... dataAbsentReason 0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


Fixed Value: masked
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1stringThe value that is unique within the system.
Example General: 123456
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name SΣ1..*HumanNameA name associated with the patient
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


Fixed Value: masked
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... family SΣC0..1stringFamily name (often called 'Surname')
.... given SΣC0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
... Slices for telecom SΣ1..*ContactPointA contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:All Slices Content/Rules for all slices
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


Fixed Value: masked
..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value SΣ1..1stringThe actual contact point details
..... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... telecom:phone SΣ0..*ContactPointA contact detail for the individual
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value SΣ1..1stringThe actual contact point details
..... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... telecom:email SΣ0..*ContactPointA contact detail for the individual
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
..... value SΣ1..1stringThe actual contact point details
..... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
... gender SΣ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


Fixed Value: masked
... birthDate SΣ1..1dateThe date of birth for the individual
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


Fixed Value: masked
... deceased[x] ?!SΣ1..1If patient is deceased, use type dateTime and set to deceased date.
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address SΣ1..*AddressAn address for the individual
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


Fixed Value: masked
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
.... district SΣ0..1stringCounty
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... period SΣ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... contact SC0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship S1..1CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name S1..1HumanNameA name associated with the contact person
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


Fixed Value: masked
..... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... telecom S1..*ContactPointA contact detail for the person
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


Fixed Value: masked
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... address S1..1AddressAddress for the contact person
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


Fixed Value: masked
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... communication S1..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language S1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


Fixed Value: masked
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Patient.extension:race.extension:ombCategory.value[x]requiredOmbRaceCategories
Patient.extension:race.extension:detailed.value[x]requiredDetailedRace
Patient.extension:race.extension:dataAbsentReason.value[x]requiredFixed Value: masked
Patient.extension:ethnicity.extension:ombCategory.value[x]requiredOmbEthnicityCategories
Patient.extension:ethnicity.extension:detailed.value[x]requiredDetailedEthnicity
Patient.extension:ethnicity.extension:dataAbsentReason.value[x]requiredFixed Value: masked
Patient.identifier.extension:dataAbsentReason.value[x]requiredFixed Value: masked
Patient.identifier.userequiredIdentifierUse
Patient.name.extension:dataAbsentReason.value[x]requiredFixed Value: masked
Patient.name.userequiredNameUse
Patient.telecom.extension:dataAbsentReason.value[x]requiredFixed Value: masked
Patient.telecom.systemrequiredContactPointSystem
Patient.telecom.userequiredContactPointUse
Patient.telecom:phone.systemrequiredFixed Value: phone
Patient.telecom:phone.userequiredContactPointUse
Patient.telecom:email.systemrequiredFixed Value: email
Patient.telecom:email.userequiredContactPointUse
Patient.genderrequiredAdministrativeGender
Patient.gender.extension:dataAbsentReason.value[x]requiredFixed Value: masked
Patient.birthDate.extension:dataAbsentReason.value[x]requiredFixed Value: masked
Patient.address.extension:dataAbsentReason.value[x]requiredFixed Value: masked
Patient.address.userequiredAddressUse
Patient.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
Patient.contact.relationshipextensiblePatientContactRelationship
Patient.contact.name.extension:dataAbsentReason.value[x]requiredFixed Value: masked
Patient.contact.name.userequiredNameUse
Patient.contact.telecom.extension:dataAbsentReason.value[x]requiredFixed Value: masked
Patient.contact.telecom.userequiredContactPointUse
Patient.contact.address.extension:dataAbsentReason.value[x]requiredFixed Value: masked
Patient.contact.address.userequiredAddressUse
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
Patient.communication.language.extension:dataAbsentReason.value[x]requiredFixed Value: masked
Patient.link.typerequiredLinkType
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*USCorePatientProfileInformation about an individual or animal receiving health care services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... race S1..1(Complex)US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:ombCategory S0..5ExtensionAmerican Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"ombCategory"
..... value[x] 1..1CodingValue of extension
Binding: OMB Race Categories (required): The 5 race category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997.

.... extension:detailed 0..*ExtensionExtended race codes
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"detailed"
..... value[x] 1..1CodingValue of extension
Binding: Detailed Race (required)
.... extension:text S1..1ExtensionRace Text
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"text"
..... value[x] 1..1stringValue of extension
.... dataAbsentReason S0..1codeFor 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
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


Fixed Value: masked
.... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
... ethnicity S1..1(Complex)US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:ombCategory S0..1ExtensionHispanic or Latino|Not Hispanic or Latino
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"ombCategory"
..... value[x] 1..1CodingValue of extension
Binding: OMB Ethnicity Categories (required)
.... extension:detailed 0..*ExtensionExtended ethnicity codes
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"detailed"
..... value[x] 1..1CodingValue of extension
Binding: Detailed ethnicity (required)
.... extension:text S1..1Extensionethnicity Text
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"text"
..... value[x] 1..1stringValue of extension
.... dataAbsentReason S0..1codeFor 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
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


Fixed Value: masked
.... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
... birthsex S0..1codeExtension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth


... genderIdentity 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity (extensible)
... birthPlace S0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... individualGenderIdentity S0..*(Complex)The individual's gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
... tribalAffiliation S0..*(Complex)Tribal affiliation and membership of the patient
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-tribal-affiliation-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..*IdentifierAn identifier for this patient
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... dataAbsentReason 0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


Fixed Value: masked
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1stringThe value that is unique within the system.
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name SΣ1..*HumanNameA name associated with the patient
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


Fixed Value: masked
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ0..1stringText representation of the full name
.... family SΣC0..1stringFamily name (often called 'Surname')
.... given SΣC0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
... Slices for telecom SΣ1..*ContactPointA contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


Fixed Value: masked
..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value SΣ1..1stringThe actual contact point details
..... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:phone SΣ0..*ContactPointA contact detail for the individual
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value SΣ1..1stringThe actual contact point details
..... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:email SΣ0..*ContactPointA contact detail for the individual
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
..... value SΣ1..1stringThe actual contact point details
..... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
... gender SΣ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


Fixed Value: masked
.... value 0..1stringPrimitive value for code
... birthDate SΣ1..1dateThe date of birth for the individual
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


Fixed Value: masked
.... value 0..1datePrimitive value for date
... deceased[x] ?!SΣ1..1If patient is deceased, use type dateTime and set to deceased date.
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address SΣ1..*AddressAn address for the individual
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


Fixed Value: masked
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
.... district SΣ0..1stringCounty
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period SΣ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... contact SC0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship S1..1CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name S1..1HumanNameA name associated with the contact person
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


Fixed Value: masked
..... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... text Σ0..1stringText representation of the full name
..... family Σ0..1stringFamily name (often called 'Surname')
..... given Σ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
.... telecom S1..*ContactPointA contact detail for the person
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


Fixed Value: masked
..... system ΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value Σ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... address S1..1AddressAddress for the contact person
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


Fixed Value: masked
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
..... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line Σ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city Σ0..1stringName of city, town etc.
Example General: Erewhon
..... district Σ0..1stringDistrict name (aka county)
Example General: Madison
..... state Σ0..1stringSub-unit of country (abbreviations ok)
..... postalCode Σ0..1stringPostal code for area
Example General: 9132
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
..... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication S1..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language S1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


Fixed Value: masked
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.extension:race.extension:ombCategory.value[x]requiredOmbRaceCategories
Patient.extension:race.extension:detailed.value[x]requiredDetailedRace
Patient.extension:race.extension:dataAbsentReason.value[x]requiredFixed Value: masked
Patient.extension:ethnicity.extension:ombCategory.value[x]requiredOmbEthnicityCategories
Patient.extension:ethnicity.extension:detailed.value[x]requiredDetailedEthnicity
Patient.extension:ethnicity.extension:dataAbsentReason.value[x]requiredFixed Value: masked
Patient.identifier.extension:dataAbsentReason.value[x]requiredFixed Value: masked
Patient.identifier.userequiredIdentifierUse
Patient.identifier.typeextensibleIdentifier Type Codes
Patient.name.extension:dataAbsentReason.value[x]requiredFixed Value: masked
Patient.name.userequiredNameUse
Patient.telecom.extension:dataAbsentReason.value[x]requiredFixed Value: masked
Patient.telecom.systemrequiredContactPointSystem
Patient.telecom.userequiredContactPointUse
Patient.telecom:phone.systemrequiredFixed Value: phone
Patient.telecom:phone.userequiredContactPointUse
Patient.telecom:email.systemrequiredFixed Value: email
Patient.telecom:email.userequiredContactPointUse
Patient.genderrequiredAdministrativeGender
Patient.gender.extension:dataAbsentReason.value[x]requiredFixed Value: masked
Patient.birthDate.extension:dataAbsentReason.value[x]requiredFixed Value: masked
Patient.address.extension:dataAbsentReason.value[x]requiredFixed Value: masked
Patient.address.userequiredAddressUse
Patient.address.typerequiredAddressType
Patient.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
Patient.maritalStatusextensibleMarital Status Codes
Patient.contact.relationshipextensiblePatientContactRelationship
Patient.contact.name.extension:dataAbsentReason.value[x]requiredFixed Value: masked
Patient.contact.name.userequiredNameUse
Patient.contact.telecom.extension:dataAbsentReason.value[x]requiredFixed Value: masked
Patient.contact.telecom.systemrequiredContactPointSystem
Patient.contact.telecom.userequiredContactPointUse
Patient.contact.address.extension:dataAbsentReason.value[x]requiredFixed Value: masked
Patient.contact.address.userequiredAddressUse
Patient.contact.address.typerequiredAddressType
Patient.contact.genderrequiredAdministrativeGender
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
Patient.communication.language.extension:dataAbsentReason.value[x]requiredFixed Value: masked
Patient.link.typerequiredLinkType

This structure is derived from USCorePatientProfile

Summary

Mandatory: 9 elements (4 nested mandatory elements)
Must-Support: 42 elements
Fixed Value: 14 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Patient.telecom is sliced based on the value of value:system

Differential View

This structure is derived from USCorePatientProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*USCorePatientProfileInformation about an individual or animal receiving health care services
... extension 2..*ExtensionExtension
... extension:race S1..1USCoreRaceExtensionUS Core Race Extension
.... extension 1..*ExtensionExtension
.... dataAbsentReason S0..1codeFor 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
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

..... value[x] S1..1codeValue of extension
Fixed Value: masked
... extension:ethnicity S1..1USCoreEthnicityExtensionUS Core ethnicity Extension
.... extension 1..*ExtensionExtension
.... dataAbsentReason S0..1codeFor 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
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

..... value[x] S1..1