HL7.FHIR.US.CARIN-BB\C4BB Patient

CARIN Consumer Directed Payer Data Exchange (CARIN IG for Blue Button®) - Local Development build (v0.1.10). See the Directory of published versions

Resource Profile: C4BB Patient

Defining URL:

http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Patient

Version:

0.1.10

Name:

C4BBPatient

Title:

C4BB Patient

Status:

Active as of 2020-11-12T01:33:42+00:00

Definition:

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.

Publisher:

HL7 Financial Management Working Group

Source Resource:

XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Patient

Notes on Fields

The Patient FHIR Resource defines a comprehensive set of data elements. Many of them are not relevant to this use case. When reviewing the Profile Snapshot, several data elements previously hidden are now exposed. Fields intended for consideration to be provided in the API are marked as Must Support; i.e., a red S or have a minimum cardinality of 1. All other data elements are not expected to be sent by a Responder; if they are sent a Requestor can choose to ignore them
The Member Id is the identifier payers assign to a beneficiary for a contract; it may be different for various lines of business; ie. QHP vs MA. The Unique Member Id is a mastered identifier across all lines of business.
Payers may decide to provide either the data that was in effect as of the date of service or the current data.
.meta.lastUpdated: Payers SHALL provide the last time the data was updated or the date of creation in the payer’s system of record, whichever comes last. Apps will use the meta.lastUpdated value to determine if the Reference resources are as of the current date or date of service.
The numbers, e.g. (1), following the data element descriptions correlate to the MapID in the CPCDS Data Dictionary and the Mapping Worksheet as described here.

Formal Views of Profile Content

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

This structure is derived from USCorePatientProfile

Summary

Mandatory: 5 elements (3 nested mandatory elements)
Must-Support: 6 elements

Slices

This structure defines the following Slices:

The element Patient.identifier is sliced based on the value of pattern:type
The element Patient.deceased[x] is sliced based on the value of type:$this

This structure is derived from USCorePatientProfile

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	USCorePatientProfile	Information about an individual or animal receiving health care services
meta	S	1..1	Meta	Metadata about the resource
lastUpdated	S	1..1	instant	When the resource version last changed
profile	S	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
identifier		1..*	(Slice Definition)	An identifier for this patient Slice: Unordered, Open by pattern:type
identifier:All Slices				Content/Rules for all slices
type		0..1	CodeableConcept	Description of identifier Binding: C4BB Patient Identifier Type (extensible)
identifier:memberid		1..*	Identifier	An identifier for this patient
type		1..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: MB
identifier:medrecnum		0..*	Identifier	An identifier for this patient
type		1..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: MR
identifier:uniquememberid		0..*	Identifier	An identifier for this patient
type		1..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType
code		1..1	code	Symbol in syntax defined by the system Fixed Value: um
identifier:patacctnum		0..*	Identifier	An identifier for this patient
type		1..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType
code		1..1	code	Symbol in syntax defined by the system Fixed Value: pat
name		1..*	HumanName	A name associated with the patient
gender		1..1	code	male \| female \| other \| unknown
birthDate		0..1	date	The date of birth for the individual
deceased[x]	S	0..1	(Slice Definition)	Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
deceasedDateTime		0..1	dateTime	Indicates if the individual is deceased or not
deceasedBoolean		0..1	boolean	Indicates if the individual is deceased or not
address
line		0..*	string	Street name, number, direction & P.O. Box etc.
city		0..1	string	Name of city, town etc.
district	S	0..1	string	District name (aka county)
state		0..1	string	Sub-unit of country (abbreviations ok)
postalCode		0..1	string	US Zip Codes
country	S	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	USCorePatientProfile	Information about an individual or animal receiving health care services
id	Σ	0..1	string	Logical id of this artifact
meta	SΣ	1..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	SΣ	1..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	SΣ	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible)
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example)
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
us-core-race	S	0..1	(Complex)	US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
us-core-ethnicity	S	0..1	(Complex)	US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
us-core-birthsex	S	0..1	code	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..*	(Slice Definition)	An identifier for this patient Slice: Unordered, Open by pattern:type
identifier:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required)
type	Σ	0..1	CodeableConcept	Description of identifier Binding: C4BB Patient Identifier Type (extensible)
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:memberid	SΣ	1..*	Identifier	An identifier for this patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible) Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: MB
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:medrecnum	SΣ	0..*	Identifier	An identifier for this patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible) Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: MR
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:uniquememberid	SΣ	0..*	Identifier	An identifier for this patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible) Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: um
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:patacctnum	SΣ	0..*	Identifier	An identifier for this patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible) Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: pat
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣI	1..*	HumanName	A name associated with the patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| nickname \| anonymous \| old \| maiden Binding: NameUse (required)
text	Σ	0..1	string	Text representation of the full name
family	SΣI	0..1	string	Family name (often called 'Surname')
given	SΣI	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	SΣ	0..*	ContactPoint	A contact detail for the individual
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣI	1..1	code	phone \| fax \| email \| pager \| url \| sms \| other Binding: ContactPointSystem (required)
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home \| work \| temp \| old \| mobile - purpose of this contact point Binding: ContactPointUse (required)
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
gender	SΣ	1..1	code	male \| female \| other \| unknown Binding: AdministrativeGender (required)
birthDate	SΣ	0..1	date	The date of birth for the individual
deceased[x]	?!SΣ	0..1	(Slice Definition)	Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	Indicates if the individual is deceased or not
address	SΣ	0..*	Address	An address for the individual
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home \| work \| temp \| old \| billing - purpose of this address Binding: AddressUse (required) Example General: home
type	Σ	0..1	code	postal \| physical \| both Binding: AddressType (required) Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	0..*	string	Street 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..1	string	Name of city, town etc. Example General: Erewhon
district	SΣ	0..1	string	District name (aka county) Example General: Madison
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible)
postalCode	SΣ	0..1	string	US Zip Codes Example General: 9132
country	SΣ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	SΣ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible)
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	I	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible)
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male \| female \| other \| unknown Binding: AdministrativeGender (required)
organization	I	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication	S	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language	S	1..1	CodeableConcept	The 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)
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(Organization \| Practitioner \| PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient \| RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by \| replaces \| refer \| seealso Binding: LinkType (required)
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	USCorePatientProfile	Information about an individual or animal receiving health care services
meta	Σ	1..1	Meta	Metadata about the resource
lastUpdated	Σ	1..1	instant	When the resource version last changed
profile	Σ	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
us-core-race		0..1	(Complex)	US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
us-core-ethnicity		0..1	(Complex)	US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
us-core-birthsex		0..1	code	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required)
identifier	Σ	1..*	(Slice Definition)	An identifier for this patient Slice: Unordered, Open by pattern:type
identifier:All Slices				Content/Rules for all slices
system	Σ	1..1	uri	The namespace for the identifier value
value	Σ	1..1	string	The value that is unique within the system.
identifier:memberid	Σ	1..*	Identifier	An identifier for this patient
system	Σ	1..1	uri	The namespace for the identifier value
value	Σ	1..1	string	The value that is unique within the system.
identifier:medrecnum	Σ	0..*	Identifier	An identifier for this patient
system	Σ	1..1	uri	The namespace for the identifier value
value	Σ	1..1	string	The value that is unique within the system.
identifier:uniquememberid	Σ	0..*	Identifier	An identifier for this patient
system	Σ	1..1	uri	The namespace for the identifier value
value	Σ	1..1	string	The value that is unique within the system.
identifier:patacctnum	Σ	0..*	Identifier	An identifier for this patient
system	Σ	1..1	uri	The namespace for the identifier value
value	Σ	1..1	string	The value that is unique within the system.
name	ΣI	1..*	HumanName	A name associated with the patient
family	ΣI	0..1	string	Family name (often called 'Surname')
given	ΣI	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
telecom	Σ	0..*	ContactPoint	A contact detail for the individual
system	ΣI	1..1	code	phone \| fax \| email \| pager \| url \| sms \| other Binding: ContactPointSystem (required)
value	Σ	1..1	string	The actual contact point details
use	?!Σ	0..1	code	home \| work \| temp \| old \| mobile - purpose of this contact point Binding: ContactPointUse (required)
gender	Σ	1..1	code	male \| female \| other \| unknown Binding: AdministrativeGender (required)
birthDate	Σ	0..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1	(Slice Definition)	Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	Σ	0..*	Address	An address for the individual
line	Σ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label
city	Σ	0..1	string	Name of city, town etc.
district	Σ	0..1	string	District name (aka county)
state	Σ	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible)
postalCode	Σ	0..1	string	US Zip Codes
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
language		1..1	CodeableConcept	The 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)
Documentation for this format

This structure is derived from USCorePatientProfile

Summary

Mandatory: 5 elements (3 nested mandatory elements)
Must-Support: 6 elements

Slices

This structure defines the following Slices:

The element Patient.identifier is sliced based on the value of pattern:type
The element Patient.deceased[x] is sliced based on the value of type:$this

Differential View

This structure is derived from USCorePatientProfile

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	USCorePatientProfile	Information about an individual or animal receiving health care services
meta	S	1..1	Meta	Metadata about the resource
lastUpdated	S	1..1	instant	When the resource version last changed
profile	S	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
identifier		1..*	(Slice Definition)	An identifier for this patient Slice: Unordered, Open by pattern:type
identifier:All Slices				Content/Rules for all slices
type		0..1	CodeableConcept	Description of identifier Binding: C4BB Patient Identifier Type (extensible)
identifier:memberid		1..*	Identifier	An identifier for this patient
type		1..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: MB
identifier:medrecnum		0..*	Identifier	An identifier for this patient
type		1..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: MR
identifier:uniquememberid		0..*	Identifier	An identifier for this patient
type		1..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType
code		1..1	code	Symbol in syntax defined by the system Fixed Value: um
identifier:patacctnum		0..*	Identifier	An identifier for this patient
type		1..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType
code		1..1	code	Symbol in syntax defined by the system Fixed Value: pat
name		1..*	HumanName	A name associated with the patient
gender		1..1	code	male \| female \| other \| unknown
birthDate		0..1	date	The date of birth for the individual
deceased[x]	S	0..1	(Slice Definition)	Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
deceasedDateTime		0..1	dateTime	Indicates if the individual is deceased or not
deceasedBoolean		0..1	boolean	Indicates if the individual is deceased or not
address
line		0..*	string	Street name, number, direction & P.O. Box etc.
city		0..1	string	Name of city, town etc.
district	S	0..1	string	District name (aka county)
state		0..1	string	Sub-unit of country (abbreviations ok)
postalCode		0..1	string	US Zip Codes
country	S	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	USCorePatientProfile	Information about an individual or animal receiving health care services
id	Σ	0..1	string	Logical id of this artifact
meta	SΣ	1..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	SΣ	1..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	SΣ	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible)
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example)
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
us-core-race	S	0..1	(Complex)	US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
us-core-ethnicity	S	0..1	(Complex)	US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
us-core-birthsex	S	0..1	code	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..*	(Slice Definition)	An identifier for this patient Slice: Unordered, Open by pattern:type
identifier:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required)
type	Σ	0..1	CodeableConcept	Description of identifier Binding: C4BB Patient Identifier Type (extensible)
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:memberid	SΣ	1..*	Identifier	An identifier for this patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible) Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: MB
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:medrecnum	SΣ	0..*	Identifier	An identifier for this patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible) Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: MR
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:uniquememberid	SΣ	0..*	Identifier	An identifier for this patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible) Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: um
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:patacctnum	SΣ	0..*	Identifier	An identifier for this patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible) Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: pat
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣI	1..*	HumanName	A name associated with the patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| nickname \| anonymous \| old \| maiden Binding: NameUse (required)
text	Σ	0..1	string	Text representation of the full name
family	SΣI	0..1	string	Family name (often called 'Surname')
given	SΣI	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	SΣ	0..*	ContactPoint	A contact detail for the individual
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣI	1..1	code	phone \| fax \| email \| pager \| url \| sms \| other Binding: ContactPointSystem (required)
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home \| work \| temp \| old \| mobile - purpose of this contact point Binding: ContactPointUse (required)
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
gender	SΣ	1..1	code	male \| female \| other \| unknown Binding: AdministrativeGender (required)
birthDate	SΣ	0..1	date	The date of birth for the individual
deceased[x]	?!SΣ	0..1	(Slice Definition)	Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	Indicates if the individual is deceased or not
address	SΣ	0..*	Address	An address for the individual
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home \| work \| temp \| old \| billing - purpose of this address Binding: AddressUse (required) Example General: home
type	Σ	0..1	code	postal \| physical \| both Binding: AddressType (required) Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	0..*	string	Street 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..1	string	Name of city, town etc. Example General: Erewhon
district	SΣ	0..1	string	District name (aka county) Example General: Madison
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible)
postalCode	SΣ	0..1	string	US Zip Codes Example General: 9132
country	SΣ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	SΣ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible)
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	I	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible)
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male \| female \| other \| unknown Binding: AdministrativeGender (required)
organization	I	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication	S	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language	S	1..1	CodeableConcept	The 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)
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(Organization \| Practitioner \| PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient \| RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by \| replaces \| refer \| seealso Binding: LinkType (required)
Documentation for this format

Other representations of profile: Schematron

Terminology Bindings

Path	Conformance	ValueSet / Code
Patient.meta.security	extensible	All Security Labels
Patient.meta.tag	example	CommonTags
Patient.language	preferred	CommonLanguages Max Binding: AllLanguages
Patient.identifier.use	required	IdentifierUse
Patient.identifier.type	extensible	C4BBPatientIdentifierType
Patient.identifier:memberid.use	required	IdentifierUse
Patient.identifier:memberid.type	extensible	Pattern: MB
Patient.identifier:medrecnum.use	required	IdentifierUse
Patient.identifier:medrecnum.type	extensible	Pattern: MR
Patient.identifier:uniquememberid.use	required	IdentifierUse
Patient.identifier:uniquememberid.type	extensible	Pattern: um
Patient.identifier:patacctnum.use	required	IdentifierUse
Patient.identifier:patacctnum.type	extensible	Pattern: pat
Patient.name.use	required	NameUse
Patient.telecom.system	required	ContactPointSystem
Patient.telecom.use	required	ContactPointUse
Patient.gender	required	AdministrativeGender
Patient.address.use	required	AddressUse
Patient.address.type	required	AddressType
Patient.address.state	extensible	UspsTwoLetterAlphabeticCodes
Patient.maritalStatus	extensible	Marital Status Codes
Patient.contact.relationship	extensible	PatientContactRelationship
Patient.contact.gender	required	AdministrativeGender
Patient.communication.language	extensible	LanguageCodesWithLanguageAndOptionallyARegionModifier
Patient.link.type	required	LinkType

Constraints

Id	Path	Details	Requirements
pat-1	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()