Profile Information - C4BB Patient

This profile builds upon the US Core Patient profile. It is used to convey information about the patient who received the services described on the claim.

Status

active as of 2022-11-28

Publisher

HL7 Financial Management Working Group

Version

2.0.0

FHIR Version

4.0.1

Copyright

Patient

Definition The US Core Patient Profile is based upon the core FHIR Patient Resource and designed to meet the applicable patient demographic data elements from the 2015 Edition Common Clinical Data Set.
Control 0..*
Summary False
Alternate Names SubjectOfCare Client Resident

Patient.id

Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Control 0..1
Summary True
Type http://hl7.org/fhirpath/System.String

Patient.meta

Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Control 1..1
Summary True
Type Meta

Patient.meta.id

Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control 0..1
Summary False
Type http://hl7.org/fhirpath/System.String

Patient.meta.extension

Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control 0..*
Summary False
Alternate Names extensions, user content
Type Extension

Patient.meta.versionId

Definition The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
Control 0..1
Summary True
Type id

Patient.meta.lastUpdated

Definition When the resource last changed - e.g. when the version changed.
Control 1..1
Summary True
Type instant

Patient.meta.source

Definition A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](http://hl7.org/fhir/R4/provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
Control 0..1
Summary True
Type uri

Patient.meta.profile

Definition A list of profiles (references to [StructureDefinition](http://hl7.org/fhir/R4/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org/fhir/R4/structuredefinition-definitions.html#StructureDefinition.url).
Control 1..*
Summary True
Type canonical

Patient.meta.security

Definition Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
Control 0..*
Summary True
Type Coding

Patient.meta.tag

Definition Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
Control 0..*
Summary True
Type Coding

Patient.implicitRules

Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Control 0..1
Summary True
Type uri

Patient.language

Definition The base language in which the resource is written.
Control 0..1
Summary False
Type code

Patient.text

Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Control 0..1
Summary False
Alternate Names narrative, html, xhtml, display
Type Narrative

Patient.contained

Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Control 0..*
Summary False
Alternate Names inline resources, anonymous resources, contained resources
Type Resource

Patient.extension

Definition An Extension
Control 0..*
Summary False
Type Extension

Patient.extension:race

Definition Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The race codes used to represent these concepts are based upon the [CDC Race and Ethnicity Code Set Version 1.0](http://www.cdc.gov/phin/resources/vocabulary/index.html) which includes over 900 concepts for representing race and ethnicity of which 921 reference race. The race concepts are grouped by and pre-mapped to the 5 OMB race categories: - American Indian or Alaska Native - Asian - Black or African American - Native Hawaiian or Other Pacific Islander - White.
Control 0..1
Summary
Type Extension

Patient.extension:ethnicity

Definition Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The ethnicity codes used to represent these concepts are based upon the [CDC ethnicity and Ethnicity Code Set Version 1.0](http://www.cdc.gov/phin/resources/vocabulary/index.html) which includes over 900 concepts for representing race and ethnicity of which 43 reference ethnicity. The ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories: - Hispanic or Latino - Not Hispanic or Latino.
Control 0..1
Summary
Type Extension

Patient.extension:birthsex

Definition A code classifying the person's sex assigned at birth as specified by the [Office of the National Coordinator for Health IT (ONC)](https://www.healthit.gov/newsroom/about-onc).
Control 0..1
Summary
Type Extension

Patient.modifierExtension

Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control 0..*
Summary False
Alternate Names extensions, user content
Type Extension

Patient.identifier

Definition An identifier for this patient.
Control 1..*
Summary True
Type Identifier

Patient.identifier.id

Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control 0..1
Summary False
Type http://hl7.org/fhirpath/System.String

Patient.identifier.extension

Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control 0..*
Summary False
Alternate Names extensions, user content
Type Extension

Patient.identifier.use

Definition The purpose of this identifier.
Control 0..1
Summary True
Type code

Patient.identifier.type

Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Control 0..1
Summary True
Type CodeableConcept

Patient.identifier.system

Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Control 1..1
Summary True
Type uri

Patient.identifier.value

Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Control 1..1
Summary True
Type string

Patient.identifier.period

Definition Time period during which identifier is/was valid for use.
Control 0..1
Summary True
Type Period

Patient.identifier.assigner

Definition Organization that issued/manages the identifier.
Control 0..1
Summary True
Type Reference

Patient.identifier:memberid

Definition An identifier for this patient.
Control 1..*
Summary True
Type Identifier

Patient.identifier:memberid.id

Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control 0..1
Summary False
Type http://hl7.org/fhirpath/System.String

Patient.identifier:memberid.extension

Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control 0..*
Summary False
Alternate Names extensions, user content
Type Extension

Patient.identifier:memberid.use

Definition The purpose of this identifier.
Control 0..1
Summary True
Type code

Patient.identifier:memberid.type

Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Control 1..1
Summary True
Type CodeableConcept

Patient.identifier:memberid.system

Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Control 1..1
Summary True
Type uri

Patient.identifier:memberid.value

Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Control 1..1
Summary True
Type string

Patient.identifier:memberid.period

Definition Time period during which identifier is/was valid for use.
Control 0..1
Summary True
Type Period

Patient.identifier:memberid.assigner

Definition Organization that issued/manages the identifier.
Control 0..1
Summary True
Type Reference

Patient.identifier:uniquememberid

Definition An identifier for this patient.
Control 0..*
Summary True
Type Identifier

Patient.identifier:uniquememberid.id

Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control 0..1
Summary False
Type http://hl7.org/fhirpath/System.String

Patient.identifier:uniquememberid.extension

Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control 0..*
Summary False
Alternate Names extensions, user content
Type Extension

Patient.identifier:uniquememberid.use

Definition The purpose of this identifier.
Control 0..1
Summary True
Type code

Patient.identifier:uniquememberid.type

Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Control 1..1
Summary True
Type CodeableConcept

Patient.identifier:uniquememberid.system

Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Control 1..1
Summary True
Type uri

Patient.identifier:uniquememberid.value

Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Control 1..1
Summary True
Type string

Patient.identifier:uniquememberid.period

Definition Time period during which identifier is/was valid for use.
Control 0..1
Summary True
Type Period

Patient.identifier:uniquememberid.assigner

Definition Organization that issued/manages the identifier.
Control 0..1
Summary True
Type Reference

Patient.active

Definition Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.
Control 0..1
Summary True
Type boolean

Patient.name

Definition A name associated with the individual.
Control 1..*
Summary True
Type HumanName

Patient.name.id

Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control 0..1
Summary False
Type http://hl7.org/fhirpath/System.String

Patient.name.extension

Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control 0..*
Summary False
Alternate Names extensions, user content
Type Extension

Patient.name.use

Definition Identifies the purpose for this name.
Control 0..1
Summary True
Type code

Patient.name.text

Definition Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.
Control 0..1
Summary True
Type string

Patient.name.family

Definition The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.
Control 0..1
Summary True
Alternate Names surname
Type string

Patient.name.given

Definition Given name.
Control 0..*
Summary True
Alternate Names first name, middle name
Type string

Patient.name.prefix

Definition Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.
Control 0..*
Summary True
Type string

Patient.name.suffix

Definition Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
Control 0..*
Summary True
Type string

Patient.name.period

Definition Indicates the period of time when this name was valid for the named person.
Control 0..1
Summary True
Type Period

Patient.telecom

Definition A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
Control 0..*
Summary True
Type ContactPoint

Patient.telecom.id

Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control 0..1
Summary False
Type http://hl7.org/fhirpath/System.String

Patient.telecom.extension

Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control 0..*
Summary False
Alternate Names extensions, user content
Type Extension

Patient.telecom.system

Definition Telecommunications form for contact point - what communications system is required to make use of the contact.
Control 1..1
Summary True
Type code

Patient.telecom.value

Definition The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Control 1..1
Summary True
Type string

Patient.telecom.use

Definition Identifies the purpose for the contact point.
Control 0..1
Summary True
Type code

Patient.telecom.rank

Definition Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Control 0..1
Summary True
Type positiveInt

Patient.telecom.period

Definition Time period when the contact point was/is in use.
Control 0..1
Summary True
Type Period

Patient.gender

Definition Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
Control 1..1
Summary True
Type code

Patient.birthDate

Definition The date of birth for the individual.
Control 0..1
Summary True
Type date

Patient.deceased[x]

Definition Indicates if the individual is deceased or not.
Control 0..1
Summary True
Type boolean

Patient.deceased[x]:deceasedDateTime

Definition Indicates if the individual is deceased or not.
Control 0..1
Summary True
Type dateTime

Patient.address

Definition An address for the individual.
Control 0..*
Summary True
Type Address

Patient.address.id

Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control 0..1
Summary False
Type http://hl7.org/fhirpath/System.String

Patient.address.extension

Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control 0..*
Summary False
Alternate Names extensions, user content
Type Extension

Patient.address.use

Definition The purpose of this address.
Control 0..1
Summary True
Type code

Patient.address.type

Definition Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
Control 0..1
Summary True
Type code

Patient.address.text

Definition Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.
Control 0..1
Summary True
Type string

Patient.address.line

Definition This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
Control 0..*
Summary True
Type string

Patient.address.city

Definition The name of the city, town, suburb, village or other community or delivery center.
Control 0..1
Summary True
Alternate Names Municpality
Type string

Patient.address.district

Definition The name of the administrative area (county).
Control 0..1
Summary True
Alternate Names County
Type string

Patient.address.state

Definition Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).
Control 0..1
Summary True
Alternate Names Province, Territory
Type string

Patient.address.postalCode

Definition A postal code designating a region defined by the postal service.
Control 0..1
Summary True
Alternate Names Zip, Zip Code
Type string

Patient.address.country

Definition Country - a nation as commonly understood or generally accepted.
Control 0..1
Summary True
Type string

Patient.address.period

Definition Time period when address was/is in use.
Control 0..1
Summary True
Type Period

Patient.maritalStatus

Definition This field contains a patient's most recent marital (civil) status.
Control 0..1
Summary False
Type CodeableConcept

Patient.multipleBirth[x]

Definition Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).
Control 0..1
Summary False
Type boolean

Patient.photo

Definition Image of the patient.
Control 0..*
Summary False
Type Attachment

Patient.contact

Definition A contact party (e.g. guardian, partner, friend) for the patient.
Control 0..*
Summary False
Type BackboneElement

Patient.contact.id

Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control 0..1
Summary False
Type http://hl7.org/fhirpath/System.String

Patient.contact.extension

Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control 0..*
Summary False
Alternate Names extensions, user content
Type Extension

Patient.contact.modifierExtension

Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control 0..*
Summary True
Alternate Names extensions, user content, modifiers
Type Extension

Patient.contact.relationship

Definition The nature of the relationship between the patient and the contact person.
Control 0..*
Summary False
Type CodeableConcept

Patient.contact.name

Definition A name associated with the contact person.
Control 0..1
Summary False
Type HumanName

Patient.contact.telecom

Definition A contact detail for the person, e.g. a telephone number or an email address.
Control 0..*
Summary False
Type ContactPoint

Patient.contact.address

Definition Address for the contact person.
Control 0..1
Summary False
Type Address

Patient.contact.gender

Definition Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.
Control 0..1
Summary False
Type code

Patient.contact.organization

Definition Organization on behalf of which the contact is acting or for which the contact is working.
Control 0..1
Summary False
Type Reference

Patient.contact.period

Definition The period during which this contact person or organization is valid to be contacted relating to this patient.
Control 0..1
Summary False
Type Period

Patient.communication

Definition A language which may be used to communicate with the patient about his or her health.
Control 0..*
Summary False
Type BackboneElement

Patient.communication.id

Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control 0..1
Summary False
Type http://hl7.org/fhirpath/System.String

Patient.communication.extension

Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control 0..*
Summary False
Alternate Names extensions, user content
Type Extension

Patient.communication.modifierExtension

Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control 0..*
Summary True
Alternate Names extensions, user content, modifiers
Type Extension

Patient.communication.language

Definition The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English.
Control 1..1
Summary False
Type CodeableConcept

Patient.communication.preferred

Definition Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).
Control 0..1
Summary False
Type boolean

Patient.generalPractitioner

Definition Patient's nominated care provider.
Control 0..*
Summary False
Alternate Names careProvider
Type Reference

Patient.managingOrganization

Definition Organization that is the custodian of the patient record.
Control 0..1
Summary True
Type Reference

Patient.link

Definition Link to another patient resource that concerns the same actual patient.
Control 0..*
Summary True
Type BackboneElement

Patient.link.id

Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control 0..1
Summary False
Type http://hl7.org/fhirpath/System.String

Patient.link.extension

Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control 0..*
Summary False
Alternate Names extensions, user content
Type Extension

Patient.link.modifierExtension

Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control 0..*
Summary True
Alternate Names extensions, user content, modifiers
Type Extension

Patient.link.other

Definition The other patient resource that the link refers to.
Control 1..1
Summary True
Type Reference

Patient.link.type

Definition The type of link between this patient resource and another patient resource.
Control 1..1
Summary True
Type code

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*USCorePatientProfileInformation about an individual or animal receiving health care services
patient-meta-profile-version: Patient: meta.profile with canonical and major.minor. version required.
... meta S1..1MetaMetadata about the resource
.... lastUpdated S1..1instantWhen the resource version last changed
.... profile 1..*canonical(StructureDefinition)Profiles this resource claims to conform to
... Slices for identifier 1..*IdentifierAn identifier for this patient
Slice: Unordered, Open by pattern:type
.... identifier:All Slices Content/Rules for all slices
..... type 0..1CodeableConceptDescription of identifier
Binding: C4BB Patient Identifier Type Value Set (extensible)
.... identifier:memberid S1..*IdentifierMember ID
..... type 1..1CodeableConceptDescription of identifier
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MB
.... identifier:uniquememberid S0..*IdentifierUnique Member ID
..... type 1..1CodeableConceptDescription of identifier
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: um
... name 1..*HumanNameA name associated with the patient
... gender 1..1codemale | female | other | unknown
... birthDate 0..1dateThe date of birth for the individual
... deceased[x] S0..1boolean, dateTimeIndicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
... deceasedDateTime 0..1dateTimeIndicates if the individual is deceased or not
... address
.... line 0..*stringStreet name, number, direction & P.O. Box etc.
.... city 0..1stringName of city, town etc.
.... state 0..1stringSub-unit of country (abbreviations ok)
.... postalCode 0..1stringUS Zip Codes
.... country S0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format