BFD-4754: Update v3 Data Dictionary Patient & Coverage to Stop Yelling At You (#3154)

Co-authored-by: aschey-forpeople <162160982+aschey-forpeople@users.noreply.github.com>

Author: millerhjacob

apps/bfd-model-idr/sushi/input/fsh/StructureDefinition-Bene-MBI.fsh

@@ -4,6 +4,6 @@ Id: Bene-MBI
 * ^status = #draft
 * ^type = "Bene-MBI"
 * . ^label = "IDR MBI Base Resource. Ignore in DD Generation"
-* BENE_MBI_ID 1..1 string "Medicare Beneficiary Identifier" "AN IDENTIFIER THAT UNIQUELY IDENTIFIES A BENEFICIARY AND REPLACES THE HEALTH INSURANCE CLAIM NUMBER (HICN) ON MEDICARE CARDS. THE FORMAT OF THE MEDICARE BENEFICIARY IDENTIFIER (MBI) IS 11-POSITIONS IN LENGTH AND CONTAINS THE FOLLOWING VALUES:  POSITION 1 Ö NUMERIC VALUES: 1 - 9  POSITION 2 Ö ALPHABETIC VALUES: A - Z (MINUS S, L, O, I, B, Z)  POSITION 3 Ö ALPHANUMERIC VALUES: 0 - 9 AND A - Z (MINUS S, L, O, I, B, Z)  POSITION 4 Ö NUMERIC VALUES: 0 - 9  POSITION 5 Ö ALPHABETIC VALUES: A - Z (MINUS S, L, O, I, B, Z)  POSITION 6 Ö ALPHANUMERIC VALUES: 0 - 9 AND A - Z (MINUS S, L, O, I, B, Z)  POSITION 7 Ö NUMERIC VALUES: 0 - 9  POSITION 8 Ö ALPHABETIC VALUES: A - Z (MINUS S, L, O, I, B, Z)  POSITION 9 Ö ALPHABETIC VALUES: A - Z (MINUS S, L, O, I, B, Z)  POSITION 10 Ö NUMERIC VALUES: 0 - 9  POSITION 11 Ö NUMERIC VALUES: 0 - 9"
-* BENE_MBI_EFCTV_DT 1..1 dateTime "MBI Effective Date" "THE EFFECTIVE DATE WHEN AN MBI IS ASSIGNED TO A BENEFICIARY."
-* BENE_MBI_OBSLT_DT 0..1 dateTime "MBI Obsolete Date" "THE END DATE WHEN AN MBI PERIOD IS CLOSED DUE TO BEING COMPROMISED OR INVOLVED IN A MERGE CROSS REFERENCE ACTION. (REPLACED BY A NEW MBI)."
+* BENE_MBI_ID 1..1 string "Medicare Beneficiary Identifier" "An identifier that uniquely identifies a beneficiary and replaces the Health Insurance Claim Number (HICN) on Medicare cards. The format of the Medicare Beneficiary Identifier (MBI) is 11-positions in length and contains the following values:  position 1 numeric values: 1 - 9  position 2 alphabetic values: A - Z (minus S, L, O, I, B, Z)  position 3 alphanumeric values: 0 - 9 and A - Z (minus S, L, O, I, B, Z)  position 4 numeric values: 0 - 9  position 5 alphabetic values: A - Z (minus S, L, O, I, B, Z)  position 6 alphanumeric values: 0 - 9 and a - z (minus S, L, O, I, B, Z)  position 7 numeric values: 0 - 9  position 8 alphabetic values: A - Z (minus S, L, O, I, B, Z)  position 9 alphabetic values: A - Z (minus S, L, O, I, B, Z)  position 10 numeric values: 0 - 9  position 11 numeric values: 0 - 9"
+* BENE_MBI_EFCTV_DT 1..1 dateTime "MBI Effective Date" "The effective date when an MBI is assigned to a beneficiary."
+* BENE_MBI_OBSLT_DT 0..1 dateTime "MBI Obsolete Date" "The end date when an MBI period is closed due to being compromised or involved in a merge cross reference action. (replaced by a new MBI)."

apps/bfd-model-idr/sushi/input/fsh/StructureDefinition-Beneficiary.fsh

@@ -10,26 +10,26 @@ Description: "IDR Beneficiary Base. Ignore in DD Generation"
 * ^baseDefinition = "http://hl7.org/fhir/StructureDefinition/Base"
 * . ^label = "IDR Beneficiary Base. Ignore in DD Generation"
 
-* BENE_1ST_NAME 1..1 string "Beneficiary First Name" "A FIRST NAME FOR A MEDICARE BENEFICIARY."
-* BENE_LAST_NAME 1..1 string "Beneficiary Last Name" "A LAST NAME OR SURNAME, INCLUDING ANY FOLLOWING TITLES OR SUFFIXES, FOR A MEDICARE BENEFICIARY."
-* BENE_MIDL_NAME 0..1 string "Beneficiary Middle Name" "THE FIRST INITIAL OF THE MEDICARE BENEFICIARYS MIDDLE NAME."
-* BENE_BRTH_DT 1..1 date "Beneficiary Date of Birth" "A DATE IDENTIFYING WHEN A BENEFICIARY IS BORN."
-* BENE_DEATH_DT 0..1 dateTime "Beneficiary Date of Death" "A DATE IDENTIFYING WHEN A BENEFICIARY DIED."
-* BENE_VRFY_DEATH_DAY_SW 0..1 boolean "Beneficiary Date of Death Verification Switch" "AN INDICATION IF THE EXACT DATE OF DEATH FOR A MEDICARE BENEFICIARY WAS VERIFIED.  VALID VALUES:  Y = YES, DATE OF DEATH HAS BEEN VERIFIED.  N = NO, DATE OF DEATH HAS NOT BEEN VERIFIED."
+* BENE_1ST_NAME 1..1 string "Beneficiary First Name" "A first name for a Medicare beneficiary."
+* BENE_LAST_NAME 1..1 string "Beneficiary Last Name" "A last name or surname, including any following titles or suffixes, for a Medicare beneficiary."
+* BENE_MIDL_NAME 0..1 string "Beneficiary Middle Name" "The first initial of the Medicare beneficiarys middle name."
+* BENE_BRTH_DT 1..1 date "Beneficiary Date of Birth" "A date identifying when a beneficiary is born."
+* BENE_DEATH_DT 0..1 dateTime "Beneficiary Date of Death" "A date identifying when a beneficiary died."
+* BENE_VRFY_DEATH_DAY_SW 0..1 boolean "Beneficiary Date of Death Verification Switch" "An indication if the exact date of death for a Medicare beneficiary was verified.  Valid values:  Y = Yes, date of death has been verified.  N = No, date of death has not been verified."
 * mbi 1..* Bene-MBI "Medicare Beneficiary Identifier (MBI)" "Beneficiary MBI"
-* BENE_XREF_EFCTV_SK 1..1 string "Current Patient FHIR ID" "AN INTEGRATED DATA REPOSITORY (IDR) DERIVED EFFECTIVE SURROGATE KEY THAT UNIQUELY IDENTIFIES A BENEFICIARY.  NOTE: BENE_XREF_EFCTV_SK REPRESENTS THE MOST CURRENT BENE_SK THAT IS IN EFFECT FOR THE BENEFICIARY. BENE_XREF_EFCTV_SK IS MORE CURRENT THAN BENE_SK AND BENE_XREF_SK ON THE BENE TABLE."
-* BENE_SK 1..1 string "Patient FHIR ID" "A UNIQUE NUMBER ASSIGNED BY THE ENROLLMENT DATA BASE (EDB) TO EACH EDB RECORD TO IDENTIFY A BENEFICIARY."
+* BENE_XREF_EFCTV_SK 1..1 string "Current Patient FHIR ID" "The current Patient ID for the beneficary."
+* BENE_SK 1..1 string "Patient FHIR ID" "A unique number assigned by the enrollment database (EDB) to each EDB record to identify a beneficiary."
 * ALL_BENE_SKs 1..* string "Beneficiary Source Key List" "A list of all source keys for the beneficiary."
 * lastUpdated 1..1 date "Last Updated Time" "The time the Patient resource was last updated."
-* GEO_USPS_STATE_CD 0..1 string "USPS State Code" "A CODE IDENTIFYING THE TWO-CHARACTER ALPHABETIC ABBREVIATION FOR A STATE IN THE UNITED STATES AS DEFINED BY THE UNITED STATES POSTAL SERVICE (USPS).    REFERENCE TABLE: GEO_USPS_STATE_CD"
-* GEO_ZIP5_CD 0..1 string "Beneficiary Zip Code - First 5" "A FIVE-DIGIT ZIP CODE DEFINED BY THE UNITED STATES POSTAL SERVICE (USPS) THAT IDENTIFIES THE DESTINATION POST OFFICE OR DELIVERY AREA.     REFERENCE TABLE: GEO_ZIP5_CD"
+* GEO_USPS_STATE_CD 0..1 string "USPS State Code" "A code identifying the two-character alphabetic abbreviation for a state in the United States as defined by the United States Postal Service (USPS).    Reference table: GEO_USPS_STATE_CD"
+* GEO_ZIP5_CD 0..1 string "Beneficiary Zip Code - First 5" "A five-digit ZIP code defined by the United States Postal Service (USPS) that identifies the destination post office or delivery area.     Reference table: GEO_ZIP5_CD"
 * BENE_LINE_1_ADR 0..1 string "Line 1 of Address" "Line 1 of Address"
 * BENE_LINE_2_ADR 0..1 string "Line 2 of Address" "Line 2 of Address"
 * BENE_LINE_3_ADR 0..1 string "Line 3 of Address" "Line 3 of Address"
 * BENE_LINE_4_ADR 0..1 string "Line 4 of Address" "Line 4 of Address"
 * BENE_LINE_5_ADR 0..1 string "Line 5 of Address" "Line 5 of Address"
 * BENE_LINE_6_ADR 0..1 string "Line 6 of Address" "Line 6 of Address"
-* GEO_ZIP_PLC_NAME 0..1 string "City Name" "A NAME OF THE CITY FOR A GIVEN ZIP CODE OF A MEDICARE BENEFICIARYS MAILING ADDRESS.    REFERENCE TABLE: GEO_ZIP5_CD"
-* CNTCT_LANG_CD 0..1 string "Contact Language Code" "A CODE IDENTIFYING THE LANGUAGE THAT THE BENEFICIARY REQUESTED CENTERS FOR MEDICARE AND MEDICAID SERVICES (CMS) USE WHEN SENDING THE MEDICARE HANDBOOK.  ENGLISH AND SPANISH ARE THE ONLY LANGUAGE CHOICES THAT CMS SUPPORTS.  THIS LANGUAGE PREFERENCE CODE IS USED EXCLUSIVELY FOR THE MEDICARE HANDBOOK.  IT IS NOT USED FOR ANY OTHER TYPE OF MAIL SENT TO BENEFICIARIES.    REFERENCE TABLE: CNTCT_LANG_CD"
-* BENE_SEX_CD 0..1 string "Beneficiary Sex Code" "A CODE IDENTIFYING THE SEX OF A MEDICARE BENEFICIARY.     REFERENCE TABLE: BENE_SEX_CD"
-* BENE_RACE_CD 0..1 string "Beneficiary Race Code" "A CODE IDENTIFYING A BENEFICIARYS RACE.  REFERENCE TABLE: BENE_RACE_CD"
+* GEO_ZIP_PLC_NAME 0..1 string "City Name" "A name of the city for a given ZIP code of a Medicare beneficiary's mailing address.    Reference table: GEO_ZIP5_CD"
+* CNTCT_LANG_CD 0..1 string "Contact Language Code" "A code identifying the language that the beneficiary requested Centers for Medicare and Medicaid Services (CMS) use when sending the Medicare handbook.  English and Spanish are the only language choices that CMS supports.  This language preference code is used exclusively for the Medicare handbook.  It is not used for any other type of mail sent to beneficiaries.    Reference table: CNTCT_LANG_CD"
+* BENE_SEX_CD 0..1 string "Beneficiary Sex Code" "A code identifying the sex of a Medicare beneficiary.     Reference table: BENE_SEX_CD"
+* BENE_RACE_CD 0..1 string "Beneficiary Race Code" "A code identifying a beneficiary's race.  Reference table: BENE_RACE_CD"