CARIN Consumer Directed Payer Data Exchange
0.3.1 - STU1

CARIN Consumer Directed Payer Data Exchange, published by HL7 Financial Management Working Group. This is not an authorized publication; it is the continuous build for version 0.3.1). 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: CARINBBPatient

CARIN Blue Button Patient Profile.

The official URL for this profile is:

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

Formal Views of Profile Content

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

This structure is derived from USCorePatientProfile

Summary

Mandatory: 1 element (6 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:$this

This structure is derived from USCorePatientProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*USCorePatientProfileInformation about an individual or animal receiving health care services
... meta
.... 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:$this
.... identifier:All Slices Content/Rules for all slices
..... type 0..1CodeableConceptDescription of identifier
Binding: Patient Identifier Type (extensible)
.... identifier:memberid 1..*IdentifierMember ID

Required Pattern: At least the following
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... 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/IdentifierTypeCS
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: mb
..... type
...... coding S1..*CodingCode defined by a terminology system
.... identifier:medrecnum 0..*IdentifierMedical Record Number

Required Pattern: At least the following
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... 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/IdentifierTypeCS
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: mr
..... type
...... coding S1..*CodingCode defined by a terminology system
.... identifier:uniquememberid 0..*IdentifierUnique Member ID

Required Pattern: At least the following
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... 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/IdentifierTypeCS
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: um
..... type
...... coding S1..*CodingCode defined by a terminology system
.... identifier:patacctnum 0..*IdentifierPatient Account Number

Required Pattern: At least the following
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... 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/IdentifierTypeCS
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: pt
..... type
...... coding S1..*CodingCode defined by a terminology system

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*USCorePatientProfileInformation about an individual or animal receiving health care services
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId ΣI0..1idVersion specific identifier
.... lastUpdated SΣI1..1instantWhen the resource version last changed
.... source ΣI0..1uriIdentifies where the resource comes from
.... profile SΣI1..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security ΣI0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag ΣI0..*CodingTags applied to this resource
Binding: CommonTags (example)
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... us-core-race SI0..1(Complex)US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
... us-core-ethnicity SI0..1(Complex)US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
... us-core-birthsex SI0..1codeExtension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI1..*(Slice Definition)An identifier for this patient
Slice: Unordered, Open by pattern:$this
.... identifier:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Patient Identifier Type (extensible)
..... system SΣI1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣI1..1stringThe value that is unique within the system.
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:memberid SΣI1..*IdentifierMember ID

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... 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/IdentifierTypeCS
....... 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
..... system0..1uriThe namespace for the identifier value
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding SΣI1..*CodingCode defined by a terminology system
...... text ΣI0..1stringPlain text representation of the concept
..... system SΣI1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣI1..1stringThe value that is unique within the system.
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:medrecnum SΣI0..*IdentifierMedical Record Number

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... 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/IdentifierTypeCS
....... 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
..... system0..1uriThe namespace for the identifier value
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding SΣI1..*CodingCode defined by a terminology system
...... text ΣI0..1stringPlain text representation of the concept
..... system SΣI1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣI1..1stringThe value that is unique within the system.
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:uniquememberid SΣI0..*IdentifierUnique Member ID

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... 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/IdentifierTypeCS
....... 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
..... system0..1uriThe namespace for the identifier value
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding SΣI1..*CodingCode defined by a terminology system
...... text ΣI0..1stringPlain text representation of the concept
..... system SΣI1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣI1..1stringThe value that is unique within the system.
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:patacctnum SΣI0..*IdentifierPatient Account Number

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... 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/IdentifierTypeCS
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: pt
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system0..1uriThe namespace for the identifier value
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding SΣI1..*CodingCode defined by a terminology system
...... text ΣI0..1stringPlain text representation of the concept
..... system SΣI1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣI1..1stringThe value that is unique within the system.
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!ΣI0..1booleanWhether this patient's record is in active use
... name SΣI1..*HumanNameA name associated with the patient
us-core-8: Patient.name.given or Patient.name.family or both SHALL be present
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!ΣI0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
.... text ΣI0..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 ΣI0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix ΣI0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period ΣI0..1PeriodTime period when name was/is in use
... telecom SΣI0..*ContactPointA contact detail for the individual
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣI1..1stringThe actual contact point details
.... use ?!SΣI0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank ΣI0..1positiveIntSpecify preferred order of use (1 = highest)
.... period ΣI0..1PeriodTime period when the contact point was/is in use
... gender SΣI1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣI0..1dateThe date of birth for the individual
... deceased[x] ?!ΣI0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address SΣI0..*AddressAn address for the individual
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!ΣI0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General: home
.... type ΣI0..1codepostal | physical | both
Binding: AddressType (required)
Example General: both
.... text ΣI0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣI0..*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ΣI0..1stringName of city, town etc.
Example General: Erewhon
.... district ΣI0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣI0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible)
.... postalCode SΣI0..1stringUS Zip Codes
Example General: 9132
.... country ΣI0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period SΣI0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23T00:00:00+11:00","end":"2010-07-01T00:00:00+10:00"}
... maritalStatus I0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible)
... multipleBirth[x] I0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo I0..*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 I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship I0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible)
.... name I0..1HumanNameA name associated with the contact person
.... telecom I0..*ContactPointA contact detail for the person
.... address I0..1AddressAddress for the contact person
.... gender I0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... organization I0..1Reference(Organization)Organization that is associated with the contact
.... period I0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication SI0..*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 I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language SI1..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 I0..1booleanLanguage preference indicator
... generalPractitioner I0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization ΣI0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!ΣI0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other ΣI1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type ΣI1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*USCorePatientProfileInformation about an individual or animal receiving health care services
... meta ΣI0..1MetaMetadata about the resource
.... lastUpdated ΣI1..1instantWhen the resource version last changed
.... profile ΣI1..*canonical(StructureDefinition)Profiles this resource claims to conform to
... us-core-race I0..1(Complex)US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
... us-core-ethnicity I0..1(Complex)US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
... identifier ΣI1..*(Slice Definition)An identifier for this patient
Slice: Unordered, Open by pattern:$this
.... identifier:All Slices Content/Rules for all slices
..... system ΣI1..1uriThe namespace for the identifier value
..... value ΣI1..1stringThe value that is unique within the system.
.... identifier:memberid ΣI1..*IdentifierMember ID

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... 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/IdentifierTypeCS
....... 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
..... system0..1uriThe namespace for the identifier value
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
..... type ΣI0..1CodeableConceptDescription of identifier
...... coding ΣI1..*CodingCode defined by a terminology system
..... system ΣI1..1uriThe namespace for the identifier value
..... value ΣI1..1stringThe value that is unique within the system.
.... identifier:medrecnum ΣI0..*IdentifierMedical Record Number

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... 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/IdentifierTypeCS
....... 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
..... system0..1uriThe namespace for the identifier value
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
..... type ΣI0..1CodeableConceptDescription of identifier
...... coding ΣI1..*CodingCode defined by a terminology system
..... system ΣI1..1uriThe namespace for the identifier value
..... value ΣI1..1stringThe value that is unique within the system.
.... identifier:uniquememberid ΣI0..*IdentifierUnique Member ID

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... 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/IdentifierTypeCS
....... 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
..... system0..1uriThe namespace for the identifier value
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
..... type ΣI0..1CodeableConceptDescription of identifier
...... coding ΣI1..*CodingCode defined by a terminology system
..... system ΣI1..1uriThe namespace for the identifier value
..... value ΣI1..1stringThe value that is unique within the system.
.... identifier:patacctnum ΣI0..*IdentifierPatient Account Number

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... 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/IdentifierTypeCS
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: pt
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system0..1uriThe namespace for the identifier value
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
..... type ΣI0..1CodeableConceptDescription of identifier
...... coding ΣI1..*CodingCode defined by a terminology system
..... system ΣI1..1uriThe namespace for the identifier value
..... value ΣI1..1stringThe value that is unique within the system.
... name ΣI1..*HumanNameA name associated with the patient
us-core-8: Patient.name.given or Patient.name.family or both SHALL be present
.... 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 ΣI0..*ContactPointA contact detail for the individual
.... system ΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value ΣI1..1stringThe actual contact point details
.... use ?!ΣI0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
... gender ΣI1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ΣI0..1dateThe date of birth for the individual
... address ΣI0..*AddressAn address for the individual
.... line ΣI0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
.... city ΣI0..1stringName of city, town etc.
.... state ΣI0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible)
.... postalCode ΣI0..1stringUS Zip Codes
.... period ΣI0..1PeriodTime period when address was/is in use
... communication I0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... language I1..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: 1 element (6 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:$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
.... 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:$this
.... identifier:All Slices Content/Rules for all slices
..... type 0..1CodeableConceptDescription of identifier
Binding: Patient Identifier Type (extensible)
.... identifier:memberid 1..*IdentifierMember ID

Required Pattern: At least the following
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... 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/IdentifierTypeCS
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: mb
..... type
...... coding S1..*CodingCode defined by a terminology system
.... identifier:medrecnum 0..*IdentifierMedical Record Number

Required Pattern: At least the following
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... 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/IdentifierTypeCS
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: mr
..... type
...... coding S1..*CodingCode defined by a terminology system
.... identifier:uniquememberid 0..*IdentifierUnique Member ID

Required Pattern: At least the following
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... 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/IdentifierTypeCS
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: um
..... type
...... coding S1..*CodingCode defined by a terminology system
.... identifier:patacctnum 0..*IdentifierPatient Account Number

Required Pattern: At least the following
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... 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/IdentifierTypeCS
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: pt
..... type
...... coding S1..*CodingCode defined by a terminology system

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*USCorePatientProfileInformation about an individual or animal receiving health care services
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId ΣI0..1idVersion specific identifier
.... lastUpdated SΣI1..1instantWhen the resource version last changed
.... source ΣI0..1uriIdentifies where the resource comes from
.... profile SΣI1..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security ΣI0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag ΣI0..*CodingTags applied to this resource
Binding: CommonTags (example)
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... us-core-race SI0..1(Complex)US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
... us-core-ethnicity SI0..1(Complex)US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
... us-core-birthsex SI0..1codeExtension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI1..*(Slice Definition)An identifier for this patient
Slice: Unordered, Open by pattern:$this
.... identifier:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Patient Identifier Type (extensible)
..... system SΣI1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣI1..1stringThe value that is unique within the system.
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:memberid SΣI1..*IdentifierMember ID

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... 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/IdentifierTypeCS
....... 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
..... system0..1uriThe namespace for the identifier value
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding SΣI1..*CodingCode defined by a terminology system
...... text ΣI0..1stringPlain text representation of the concept
..... system SΣI1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣI1..1stringThe value that is unique within the system.
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:medrecnum SΣI0..*IdentifierMedical Record Number

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... 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/IdentifierTypeCS
....... version0..1stringVersion of the system - if relevant
....... code1..1