Blue Button 2.0 Implementation Guide

SD.7 StructureDefinition-bluebutton-patient-claim

This profile sets minimum expectations for the [Patient] resource to record, search and fetch basic demographics and other administrative information about an individual patient. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

Example Usage Scenarios:

The following are example usage scenarios for the Blue Button Patient profile:

Mandatory Data Elements and Terminology

The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each Patient must have:

  1. an id
  2. patient identifiers (e.g. BeneID, hicnHash)
  3. a patient name
  4. a gender
  5. an address

If the data is available a Patient shall include:

  1. a birth date
  2. a race

Profile specific implementation guidance:

  • none

Examples

  • none

SD.7.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-patient-claim.html

Published on Wed Feb 14 00:00:00 UTC 2018 as a draft by CMS Blue Button 2.0 Team.

This profile builds on Patient

Complete Summary of the Mandatory Requirements

  1. An id in Patient.id
  2. One or more medical record numbers in Patient.identifier
    • each Patient.identifier must have:
      • an identifier.system
      • an identifier.value that is unique within the system.
  3. One name in Patient.name
    • each Patient.name must have:
      • a name.use
      • a name.family
      • a name.given
  4. One gender in Patient.gender
  5. One address in Patient.address
    • each patient.address must have:
      • a name.use - a name.family - a name.given

Summary of the Must Support Requirements

Additionally your system must support:

  1. A date of birth in Patient.birthDate
  2. One race codes in Patient.extension = Blue ButtonRace Extension which:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*Information about an individual or animal receiving health care services
... id S1..
... identifier S1..
.... use ..0
.... type ..0
.... system S1..
.... value S1..
.... period ..0
.... assigner ..0
... active ..0
... name S1..1
.... use 1..
.... text ..0
.... family S1..
.... given S1..
.... prefix ..0
.... suffix ..0
.... period ..0
... telecom ..0
... gender S1..
... deceased[x] ..0
... address S1..1
.... use ..0
.... type ..0
.... text ..0
.... line ..0
.... city ..0
.... district S1..
.... state S1..
.... postalCode S1..
.... country ..0
.... period ..0
... maritalStatus ..0
... multipleBirth[x] ..0
... photo ..0
... contact ..0
... animal ..0
... communication ..0
... generalPractitioner ..0
... managingOrganization ..0
... link ..0
... bluebutton-patient-race-extension 0..1CodingOptional Extensions Element
URL: https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-patient-race-extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*Information about an individual or animal receiving health care services
... id SΣ1..1idLogical id of this artifact
... bluebutton-patient-race-extension I0..1CodingAdditional Content defined by implementations
URL: https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-patient-race-extension
Binding: Blue Button Race Codes (required)
ext-1: Must have either extensions or value[x], not both
... identifier SΣ1..*IdentifierAn identifier for this patient
.... id 0..1stringxml:id (or equivalent in JSON)
.... system SΣ1..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value SΣ1..1stringThe value that is unique
Example General': 123456
... name SΣ1..1HumanNameA name associated with the patient
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!SΣ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
.... family SΣ1..1stringFamily name (often called 'Surname')
.... given SΣ1..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
... gender SΣ1..1codemale | female | other | unknown
Binding: Patient Gender (required)
... birthDate Σ0..1dateThe date of birth for the individual
... address SΣ1..1AddressAddresses for the individual
.... id 0..1stringxml:id (or equivalent in JSON)
.... district SΣ1..1stringDistrict name (aka county)
Example General': Madison
.... state SΣ1..1stringSub-unit of country (abbreviations ok)
.... postalCode SΣ1..1stringPostal code for area
Example General': 9132

doco Documentation for this format

Complete Summary of the Mandatory Requirements

  1. An id in Patient.id
  2. One or more medical record numbers in Patient.identifier
    • each Patient.identifier must have:
      • an identifier.system
      • an identifier.value that is unique within the system.
  3. One name in Patient.name
    • each Patient.name must have:
      • a name.use
      • a name.family
      • a name.given
  4. One gender in Patient.gender
  5. One address in Patient.address
    • each patient.address must have:
      • a name.use - a name.family - a name.given

Summary of the Must Support Requirements

Additionally your system must support:

  1. A date of birth in Patient.birthDate
  2. One race codes in Patient.extension = Blue ButtonRace Extension which:

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*Information about an individual or animal receiving health care services
... id S1..
... identifier S1..
.... use ..0
.... type ..0
.... system S1..
.... value S1..
.... period ..0
.... assigner ..0
... active ..0
... name S1..1
.... use 1..
.... text ..0
.... family S1..
.... given S1..
.... prefix ..0
.... suffix ..0
.... period ..0
... telecom ..0
... gender S1..
... deceased[x] ..0
... address S1..1
.... use ..0
.... type ..0
.... text ..0
.... line ..0
.... city ..0
.... district S1..
.... state S1..
.... postalCode S1..
.... country ..0
.... period ..0
... maritalStatus ..0
... multipleBirth[x] ..0
... photo ..0
... contact ..0
... animal ..0
... communication ..0
... generalPractitioner ..0
... managingOrganization ..0
... link ..0
... bluebutton-patient-race-extension 0..1CodingOptional Extensions Element
URL: https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-patient-race-extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*Information about an individual or animal receiving health care services
... id SΣ1..1idLogical id of this artifact
... bluebutton-patient-race-extension I0..1CodingAdditional Content defined by implementations
URL: https://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-patient-race-extension
Binding: Blue Button Race Codes (required)
ext-1: Must have either extensions or value[x], not both
... identifier SΣ1..*IdentifierAn identifier for this patient
.... id 0..1stringxml:id (or equivalent in JSON)
.... system SΣ1..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value SΣ1..1stringThe value that is unique
Example General': 123456
... name SΣ1..1HumanNameA name associated with the patient
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!SΣ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
.... family SΣ1..1stringFamily name (often called 'Surname')
.... given SΣ1..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
... gender SΣ1..1codemale | female | other | unknown
Binding: Patient Gender (required)
... birthDate Σ0..1dateThe date of birth for the individual
... address SΣ1..1AddressAddresses for the individual
.... id 0..1stringxml:id (or equivalent in JSON)
.... district SΣ1..1stringDistrict name (aka county)
Example General': Madison
.... state SΣ1..1stringSub-unit of country (abbreviations ok)
.... postalCode SΣ1..1stringPostal code for area
Example General': 9132

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron