CARIN Consumer Directed Payer Data Exchange (CARIN IG for Blue Button®)
1.0.0 - STU1

CARIN Consumer Directed Payer Data Exchange (CARIN IG for Blue Button®), published by HL7 Financial Management 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/carin-bb/ and changes regularly. See the Directory of published versions

Resource Profile: C4BB Patient

Defining URL:http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Patient
Version:1.0.0
Name:C4BBPatient
Title:C4BB Patient
Status:Active as of 2020-11-23T16:49:10+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: 10 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*USCorePatientProfileInformation about an individual or animal receiving health care services
... meta S1..1MetaMetadata about the resource
.... lastUpdated S1..1instantWhen the resource version last changed
.... profile S1..*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..1CodeableConceptDescription of identifier
Binding: C4BB Patient Identifier Type (extensible)
.... identifier:memberid S1..*IdentifierAn identifier for this patient
..... 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:medrecnum S0..*IdentifierAn identifier for this patient
..... 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: MR
.... identifier:uniquememberid S0..*IdentifierAn identifier for this patient
..... 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
.... identifier:patacctnum S0..*IdentifierAn identifier for this patient
..... 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: pat
... name 1..*HumanNameA name associated with the patient
... birthDate 0..1dateThe date of birth for the individual
... deceased[x] S0..1(Slice Definition)Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
... deceasedDateTime 0..1dateTimeIndicates if the individual is deceased or not
... deceasedBoolean 0..1booleanIndicates 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.
.... district S0..1stringDistrict name (aka county)
.... 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
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*USCorePatientProfileInformation about an individual or animal receiving health care services
... id Σ0..1stringLogical id of this artifact
... meta SΣ1..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated SΣ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile SΣ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... us-core-race S0..1(Complex)US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
... us-core-ethnicity S0..1(Complex)US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
... us-core-birthsex S0..1codeExtension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth


... modifierExtension ?!0..*ExtensionExtensions 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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... 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: C4BB Patient Identifier Type (extensible)
..... 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)
.... identifier:memberid SΣ1..*IdentifierAn identifier for this patient
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..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.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MB
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... 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)
.... identifier:medrecnum SΣ0..*IdentifierAn identifier for this patient
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..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.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MR
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... 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)
.... identifier:uniquememberid SΣ0..*IdentifierAn identifier for this patient
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..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.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: um
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... 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)
.... identifier:patacctnum SΣ0..*IdentifierAn identifier for this patient
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..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.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: pat
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... 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ΣI1..*HumanNameA name associated with the patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... 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ΣI0..1stringFamily name (often called 'Surname')
.... given SΣI0..*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 SΣ0..*ContactPointA contact detail for the individual
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣI1..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
... gender SΣ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ0..1dateThe 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
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
.... deceased[x]:deceasedDateTime ?!Σ0..1dateTimeIndicates if the individual is deceased or not
.... deceased[x]:deceasedBoolean ?!Σ0..1booleanIndicates if the individual is deceased or not
... address SΣ0..*AddressAn address for the individual
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... 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..1stringDistrict name (aka county)
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 SΣ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 I0..*BackboneElementA 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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization I0..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 S0..*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)
.... 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
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*USCorePatientProfileInformation about an individual or animal receiving health care services
... meta Σ1..1MetaMetadata about the resource
.... lastUpdated Σ1..1instantWhen 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
... 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..1uriThe namespace for the identifier value
..... value Σ1..1stringThe value that is unique within the system.
.... identifier:memberid Σ1..*IdentifierAn identifier for this patient
..... system Σ1..1uriThe namespace for the identifier value
..... value Σ1..1stringThe value that is unique within the system.
.... identifier:medrecnum Σ0..*IdentifierAn identifier for this patient
..... system Σ1..1uriThe namespace for the identifier value
..... value Σ1..1stringThe value that is unique within the system.
.... identifier:uniquememberid Σ0..*IdentifierAn identifier for this patient
..... system Σ1..1uriThe namespace for the identifier value
..... value Σ1..1stringThe value that is unique within the system.
.... identifier:patacctnum Σ0..*IdentifierAn identifier for this patient
..... system Σ1..1uriThe namespace for the identifier value
..... value Σ1..1stringThe value that is unique within the system.
... name ΣI1..*HumanNameA name associated with the patient
.... family ΣI0..1stringFamily name (often called 'Surname')
.... given ΣI0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
... telecom Σ0..*ContactPointA contact detail for the individual
.... system ΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ1..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
... gender Σ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate Σ0..1dateThe 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
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address Σ0..*AddressAn address for the individual
.... 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
.... city Σ0..1stringName of city, town etc.
.... district Σ0..1stringDistrict name (aka county)
.... state Σ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.

.... postalCode Σ0..1stringUS Zip Codes
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... language 1..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)

doco Documentation for this format

This structure is derived from USCorePatientProfile

Summary

Mandatory: 5 elements (3 nested mandatory elements)
Must-Support: 10 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*USCorePatientProfileInformation about an individual or animal receiving health care services
... meta S1..1MetaMetadata about the resource
.... lastUpdated S1..1instantWhen the resource version last changed
.... profile S1..*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..1CodeableConceptDescription of identifier
Binding: C4BB Patient Identifier Type (extensible)
.... identifier:memberid S1..*IdentifierAn identifier for this patient
..... 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:medrecnum S0..*IdentifierAn identifier for this patient
..... 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: MR
.... identifier:uniquememberid S0..*IdentifierAn identifier for this patient
..... 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
.... identifier:patacctnum S0..*IdentifierAn identifier for this patient
..... 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: pat
... name 1..*HumanNameA name associated with the patient
... birthDate 0..1dateThe date of birth for the individual
... deceased[x] S0..1(Slice Definition)Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
... deceasedDateTime 0..1dateTimeIndicates if the individual is deceased or not
... deceasedBoolean 0..1booleanIndicates 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.
.... district S0..1stringDistrict name (aka county)
.... 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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*USCorePatientProfileInformation about an individual or animal receiving health care services
... id Σ0..1stringLogical id of this artifact
... meta SΣ1..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated SΣ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile SΣ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... us-core-race S0..1(Complex)US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
... us-core-ethnicity S0..1(Complex)US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
... us-core-birthsex S0..1codeExtension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth


... modifierExtension ?!0..*ExtensionExtensions 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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... 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: C4BB Patient Identifier Type (extensible)
..... 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)
.... identifier:memberid SΣ1..*IdentifierAn identifier for this patient
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..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.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MB
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... 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)
.... identifier:medrecnum SΣ0..*IdentifierAn identifier for this patient
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..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.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MR
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... 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)
.... identifier:uniquememberid SΣ0..*IdentifierAn identifier for this patient
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..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.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: um
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... 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)
.... identifier:patacctnum SΣ0..*IdentifierAn identifier for this patient
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..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.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: pat
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... 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ΣI1..*HumanNameA name associated with the patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... 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ΣI0..1stringFamily name (often called 'Surname')
.... given SΣI0..*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 SΣ0..*ContactPointA contact detail for the individual
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣI1..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
... gender SΣ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ0..1dateThe 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
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
.... deceased[x]:deceasedDateTime ?!Σ0..1dateTimeIndicates if the individual is deceased or not
.... deceased[x]:deceasedBoolean ?!Σ0..1booleanIndicates if the individual is deceased or not
... address SΣ0..*AddressAn address for the individual
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... 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..1stringDistrict name (aka county)
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 SΣ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 I0..*BackboneElementA 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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization I0..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 S0..*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)
.... 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