US Veterans Health Administration FHIR Map Set Implementation Guide
1.3.1 - 250401
US Veterans Health Administration FHIR Map Set Implementation Guide
1.3.1 - 250401
Publication Build: This will be filled in by the publication tooling
| Official URL: http://va.gov/fhir/StructureDefinition/Patient2 | Version: 1.3.1 | |||
| Active as of 2025-03-31 | Computable Name: Patient2 | |||
This StructureDefinition contains the Logical Model for the mapped parts of the source PATIENT (2)
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Patient2 |
0..* | Base | PATIENT (2) Instances of this logical model can be the target of a Reference | |
  integrationControlNumber |
0..1 | Element | INTEGRATION CONTROL NUMBER (-991.01) | |
| name |
0..1 | Element | NAME (-.01) | |
| phoneNumberResidence |
0..1 | Element | PHONE NUMBER [RESIDENCE] (-.131) | |
| phoneNumberWork |
0..1 | Element | PHONE NUMBER [WORK] (-.132) | |
| phoneNumberCellular |
0..1 | Element | PHONE NUMBER [CELLULAR] (-.134) | |
| dateOfBirth |
0..1 | Element | DATE OF BIRTH (-.03) | |
| dateOfDeath |
0..1 | Element | DATE OF DEATH (-.351) | |
| streetAddressLine1 |
0..1 | Element | STREET ADDRESS [LINE 1] (-.111) | |
| streetAddressLine2 |
0..1 | Element | STREET ADDRESS [LINE 2] (-.112) | |
| streetAddressLine3 |
0..1 | Element | STREET ADDRESS [LINE 3] (-.113) | |
| city |
0..1 | Element | CITY (-.114) | |
| state |
0..1 | Element | STATE (-.115) | |
| zip4 |
0..1 | Element | ZIP+4 (-.1112) | |
| country |
0..1 | Element | COUNTRY (-.1173) | |
| temporaryAddressStartDate |
0..1 | Element | TEMPORARY ADDRESS START DATE (-.1217) | |
| temporaryAddressEndDate |
0..1 | Element | TEMPORARY ADDRESS END DATE (-.1218) | |
 languageDatetime |
0..1 | Reference(LANGUAGE DATE/TIME (2.07)) | LANGUAGE DATE/TIME (-7) | |
| sex |
0..1 | Coding | SEX (-.02) Binding: adminGender VistA (preferred) | |
| selfIdentifiedGender |
0..1 | Coding | SELF IDENTIFIED GENDER (-.024) Binding: genderIdentity VistA (preferred) | |
| ethnicityInformation |
0..1 | Coding | ETHNICITY INFORMATION (-6) Binding: ethnicityCategory VistA (preferred) | |
| raceInformation |
0..1 | Coding | RACE INFORMATION (-2) Binding: raceCategory VistA (preferred) | |
| maritalStatus |
0..1 | Coding | MARITAL STATUS (-.05) Binding: MaritalStatus VistA (preferred) | |
| religiousPreference |
0..1 | Coding | RELIGIOUS PREFERENCE (-.08) Binding: Religion VistA (preferred) | |
| appointment |
0..1 | Element | APPOINTMENT (-1900) | |
 laboratoryReference |
0..1 | Reference(LAB DATA (63)) | LABORATORY REFERENCE (-63) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Patient2.sex | preferred | AdminGender_VistAhttp://va.gov/fhir/ValueSet/adminGender-vistafrom this IG | |
| Patient2.selfIdentifiedGender | preferred | GenderIdentity_VistAhttp://va.gov/fhir/ValueSet/genderIdentity-vistafrom this IG | |
| Patient2.ethnicityInformation | preferred | EthnicityCategory_VistAhttp://va.gov/fhir/ValueSet/ethnicityCategory-vistafrom this IG | |
| Patient2.raceInformation | preferred | RaceCategory_VistAhttp://va.gov/fhir/ValueSet/raceCategory-vistafrom this IG | |
| Patient2.maritalStatus | preferred | MaritalStatus_VistAhttp://va.gov/fhir/ValueSet/MaritalStatus-vistafrom this IG | |
| Patient2.religiousPreference | preferred | Religion_VistAhttp://va.gov/fhir/ValueSet/Religion-vistafrom this IG |
This structure is derived from Base
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient2 |
0..* | Base | PATIENT (2) Instances of this logical model can be the target of a Reference | |
| integrationControlNumber |
0..1 | Element | INTEGRATION CONTROL NUMBER (-991.01) | |
| name |
0..1 | Element | NAME (-.01) | |
| phoneNumberResidence |
0..1 | Element | PHONE NUMBER [RESIDENCE] (-.131) | |
| phoneNumberWork |
0..1 | Element | PHONE NUMBER [WORK] (-.132) | |
| phoneNumberCellular |
0..1 | Element | PHONE NUMBER [CELLULAR] (-.134) | |
| dateOfBirth |
0..1 | Element | DATE OF BIRTH (-.03) | |
| dateOfDeath |
0..1 | Element | DATE OF DEATH (-.351) | |
| streetAddressLine1 |
0..1 | Element | STREET ADDRESS [LINE 1] (-.111) | |
| streetAddressLine2 |
0..1 | Element | STREET ADDRESS [LINE 2] (-.112) | |
| streetAddressLine3 |
0..1 | Element | STREET ADDRESS [LINE 3] (-.113) | |
| city |
0..1 | Element | CITY (-.114) | |
| state |
0..1 | Element | STATE (-.115) | |
| zip4 |
0..1 | Element | ZIP+4 (-.1112) | |
| country |
0..1 | Element | COUNTRY (-.1173) | |
| temporaryAddressStartDate |
0..1 | Element | TEMPORARY ADDRESS START DATE (-.1217) | |
| temporaryAddressEndDate |
0..1 | Element | TEMPORARY ADDRESS END DATE (-.1218) | |
| languageDatetime |
0..1 | Reference(LANGUAGE DATE/TIME (2.07)) | LANGUAGE DATE/TIME (-7) | |
| sex |
0..1 | Coding | SEX (-.02) Binding: adminGender VistA (preferred) | |
| selfIdentifiedGender |
0..1 | Coding | SELF IDENTIFIED GENDER (-.024) Binding: genderIdentity VistA (preferred) | |
| ethnicityInformation |
0..1 | Coding | ETHNICITY INFORMATION (-6) Binding: ethnicityCategory VistA (preferred) | |
| raceInformation |
0..1 | Coding | RACE INFORMATION (-2) Binding: raceCategory VistA (preferred) | |
| maritalStatus |
0..1 | Coding | MARITAL STATUS (-.05) Binding: MaritalStatus VistA (preferred) | |
| religiousPreference |
0..1 | Coding | RELIGIOUS PREFERENCE (-.08) Binding: Religion VistA (preferred) | |
| appointment |
0..1 | Element | APPOINTMENT (-1900) | |
| laboratoryReference |
0..1 | Reference(LAB DATA (63)) | LABORATORY REFERENCE (-63) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Patient2.sex | preferred | AdminGender_VistAhttp://va.gov/fhir/ValueSet/adminGender-vistafrom this IG | |
| Patient2.selfIdentifiedGender | preferred | GenderIdentity_VistAhttp://va.gov/fhir/ValueSet/genderIdentity-vistafrom this IG | |
| Patient2.ethnicityInformation | preferred | EthnicityCategory_VistAhttp://va.gov/fhir/ValueSet/ethnicityCategory-vistafrom this IG | |
| Patient2.raceInformation | preferred | RaceCategory_VistAhttp://va.gov/fhir/ValueSet/raceCategory-vistafrom this IG | |
| Patient2.maritalStatus | preferred | MaritalStatus_VistAhttp://va.gov/fhir/ValueSet/MaritalStatus-vistafrom this IG | |
| Patient2.religiousPreference | preferred | Religion_VistAhttp://va.gov/fhir/ValueSet/Religion-vistafrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient2 |
0..* | Base | PATIENT (2) Instances of this logical model can be the target of a Reference | |
| integrationControlNumber |
0..1 | Element | INTEGRATION CONTROL NUMBER (-991.01) | |
| name |
0..1 | Element | NAME (-.01) | |
| phoneNumberResidence |
0..1 | Element | PHONE NUMBER [RESIDENCE] (-.131) | |
| phoneNumberWork |
0..1 | Element | PHONE NUMBER [WORK] (-.132) | |
| phoneNumberCellular |
0..1 | Element | PHONE NUMBER [CELLULAR] (-.134) | |
| dateOfBirth |
0..1 | Element | DATE OF BIRTH (-.03) | |
| dateOfDeath |
0..1 | Element | DATE OF DEATH (-.351) | |
| streetAddressLine1 |
0..1 | Element | STREET ADDRESS [LINE 1] (-.111) | |
| streetAddressLine2 |
0..1 | Element | STREET ADDRESS [LINE 2] (-.112) | |
| streetAddressLine3 |
0..1 | Element | STREET ADDRESS [LINE 3] (-.113) | |
| city |
0..1 | Element | CITY (-.114) | |
| state |
0..1 | Element | STATE (-.115) | |
| zip4 |
0..1 | Element | ZIP+4 (-.1112) | |
| country |
0..1 | Element | COUNTRY (-.1173) | |
| temporaryAddressStartDate |
0..1 | Element | TEMPORARY ADDRESS START DATE (-.1217) | |
| temporaryAddressEndDate |
0..1 | Element | TEMPORARY ADDRESS END DATE (-.1218) | |
| languageDatetime |
0..1 | Reference(LANGUAGE DATE/TIME (2.07)) | LANGUAGE DATE/TIME (-7) | |
| sex |
0..1 | Coding | SEX (-.02) Binding: adminGender VistA (preferred) | |
| selfIdentifiedGender |
0..1 | Coding | SELF IDENTIFIED GENDER (-.024) Binding: genderIdentity VistA (preferred) | |
| ethnicityInformation |
0..1 | Coding | ETHNICITY INFORMATION (-6) Binding: ethnicityCategory VistA (preferred) | |
| raceInformation |
0..1 | Coding | RACE INFORMATION (-2) Binding: raceCategory VistA (preferred) | |
| maritalStatus |
0..1 | Coding | MARITAL STATUS (-.05) Binding: MaritalStatus VistA (preferred) | |
| religiousPreference |
0..1 | Coding | RELIGIOUS PREFERENCE (-.08) Binding: Religion VistA (preferred) | |
| appointment |
0..1 | Element | APPOINTMENT (-1900) | |
| laboratoryReference |
0..1 | Reference(LAB DATA (63)) | LABORATORY REFERENCE (-63) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Patient2.sex | preferred | AdminGender_VistAhttp://va.gov/fhir/ValueSet/adminGender-vistafrom this IG | |
| Patient2.selfIdentifiedGender | preferred | GenderIdentity_VistAhttp://va.gov/fhir/ValueSet/genderIdentity-vistafrom this IG | |
| Patient2.ethnicityInformation | preferred | EthnicityCategory_VistAhttp://va.gov/fhir/ValueSet/ethnicityCategory-vistafrom this IG | |
| Patient2.raceInformation | preferred | RaceCategory_VistAhttp://va.gov/fhir/ValueSet/raceCategory-vistafrom this IG | |
| Patient2.maritalStatus | preferred | MaritalStatus_VistAhttp://va.gov/fhir/ValueSet/MaritalStatus-vistafrom this IG | |
| Patient2.religiousPreference | preferred | Religion_VistAhttp://va.gov/fhir/ValueSet/Religion-vistafrom this IG |
This structure is derived from Base
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient2 |
0..* | Base | PATIENT (2) Instances of this logical model can be the target of a Reference | |
| integrationControlNumber |
0..1 | Element | INTEGRATION CONTROL NUMBER (-991.01) | |
| name |
0..1 | Element | NAME (-.01) | |
| phoneNumberResidence |
0..1 | Element | PHONE NUMBER [RESIDENCE] (-.131) | |
| phoneNumberWork |
0..1 | Element | PHONE NUMBER [WORK] (-.132) | |
| phoneNumberCellular |
0..1 | Element | PHONE NUMBER [CELLULAR] (-.134) | |
| dateOfBirth |
0..1 | Element | DATE OF BIRTH (-.03) | |
| dateOfDeath |
0..1 | Element | DATE OF DEATH (-.351) | |
| streetAddressLine1 |
0..1 | Element | STREET ADDRESS [LINE 1] (-.111) | |
| streetAddressLine2 |
0..1 | Element | STREET ADDRESS [LINE 2] (-.112) | |
| streetAddressLine3 |
0..1 | Element | STREET ADDRESS [LINE 3] (-.113) | |
| city |
0..1 | Element | CITY (-.114) | |
| state |
0..1 | Element | STATE (-.115) | |
| zip4 |
0..1 | Element | ZIP+4 (-.1112) | |
| country |
0..1 | Element | COUNTRY (-.1173) | |
| temporaryAddressStartDate |
0..1 | Element | TEMPORARY ADDRESS START DATE (-.1217) | |
| temporaryAddressEndDate |
0..1 | Element | TEMPORARY ADDRESS END DATE (-.1218) | |
| languageDatetime |
0..1 | Reference(LANGUAGE DATE/TIME (2.07)) | LANGUAGE DATE/TIME (-7) | |
| sex |
0..1 | Coding | SEX (-.02) Binding: adminGender VistA (preferred) | |
| selfIdentifiedGender |
0..1 | Coding | SELF IDENTIFIED GENDER (-.024) Binding: genderIdentity VistA (preferred) | |
| ethnicityInformation |
0..1 | Coding | ETHNICITY INFORMATION (-6) Binding: ethnicityCategory VistA (preferred) | |
| raceInformation |
0..1 | Coding | RACE INFORMATION (-2) Binding: raceCategory VistA (preferred) | |
| maritalStatus |
0..1 | Coding | MARITAL STATUS (-.05) Binding: MaritalStatus VistA (preferred) | |
| religiousPreference |
0..1 | Coding | RELIGIOUS PREFERENCE (-.08) Binding: Religion VistA (preferred) | |
| appointment |
0..1 | Element | APPOINTMENT (-1900) | |
| laboratoryReference |
0..1 | Reference(LAB DATA (63)) | LABORATORY REFERENCE (-63) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Patient2.sex | preferred | AdminGender_VistAhttp://va.gov/fhir/ValueSet/adminGender-vistafrom this IG | |
| Patient2.selfIdentifiedGender | preferred | GenderIdentity_VistAhttp://va.gov/fhir/ValueSet/genderIdentity-vistafrom this IG | |
| Patient2.ethnicityInformation | preferred | EthnicityCategory_VistAhttp://va.gov/fhir/ValueSet/ethnicityCategory-vistafrom this IG | |
| Patient2.raceInformation | preferred | RaceCategory_VistAhttp://va.gov/fhir/ValueSet/raceCategory-vistafrom this IG | |
| Patient2.maritalStatus | preferred | MaritalStatus_VistAhttp://va.gov/fhir/ValueSet/MaritalStatus-vistafrom this IG | |
| Patient2.religiousPreference | preferred | Religion_VistAhttp://va.gov/fhir/ValueSet/Religion-vistafrom this IG |
Differential View
This structure is derived from Base
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient2 |
0..* | Base | PATIENT (2) Instances of this logical model can be the target of a Reference | |
| integrationControlNumber |
0..1 | Element | INTEGRATION CONTROL NUMBER (-991.01) | |
| name |
0..1 | Element | NAME (-.01) | |
| phoneNumberResidence |
0..1 | Element | PHONE NUMBER [RESIDENCE] (-.131) | |
| phoneNumberWork |
0..1 | Element | PHONE NUMBER [WORK] (-.132) | |
| phoneNumberCellular |
0..1 | Element | PHONE NUMBER [CELLULAR] (-.134) | |
| dateOfBirth |
0..1 | Element | DATE OF BIRTH (-.03) | |
| dateOfDeath |
0..1 | Element | DATE OF DEATH (-.351) | |
| streetAddressLine1 |
0..1 | Element | STREET ADDRESS [LINE 1] (-.111) | |
| streetAddressLine2 |
0..1 | Element | STREET ADDRESS [LINE 2] (-.112) | |
| streetAddressLine3 |
0..1 | Element | STREET ADDRESS [LINE 3] (-.113) | |
| city |
0..1 | Element | CITY (-.114) | |
| state |
0..1 | Element | STATE (-.115) | |
| zip4 |
0..1 | Element | ZIP+4 (-.1112) | |
| country |
0..1 | Element | COUNTRY (-.1173) | |
| temporaryAddressStartDate |
0..1 | Element | TEMPORARY ADDRESS START DATE (-.1217) | |
| temporaryAddressEndDate |
0..1 | Element | TEMPORARY ADDRESS END DATE (-.1218) | |
| languageDatetime |
0..1 | Reference(LANGUAGE DATE/TIME (2.07)) | LANGUAGE DATE/TIME (-7) | |
| sex |
0..1 | Coding | SEX (-.02) Binding: adminGender VistA (preferred) | |
| selfIdentifiedGender |
0..1 | Coding | SELF IDENTIFIED GENDER (-.024) Binding: genderIdentity VistA (preferred) | |
| ethnicityInformation |
0..1 | Coding | ETHNICITY INFORMATION (-6) Binding: ethnicityCategory VistA (preferred) | |
| raceInformation |
0..1 | Coding | RACE INFORMATION (-2) Binding: raceCategory VistA (preferred) | |
| maritalStatus |
0..1 | Coding | MARITAL STATUS (-.05) Binding: MaritalStatus VistA (preferred) | |
| religiousPreference |
0..1 | Coding | RELIGIOUS PREFERENCE (-.08) Binding: Religion VistA (preferred) | |
| appointment |
0..1 | Element | APPOINTMENT (-1900) | |
| laboratoryReference |
0..1 | Reference(LAB DATA (63)) | LABORATORY REFERENCE (-63) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Patient2.sex | preferred | AdminGender_VistAhttp://va.gov/fhir/ValueSet/adminGender-vistafrom this IG | |
| Patient2.selfIdentifiedGender | preferred | GenderIdentity_VistAhttp://va.gov/fhir/ValueSet/genderIdentity-vistafrom this IG | |
| Patient2.ethnicityInformation | preferred | EthnicityCategory_VistAhttp://va.gov/fhir/ValueSet/ethnicityCategory-vistafrom this IG | |
| Patient2.raceInformation | preferred | RaceCategory_VistAhttp://va.gov/fhir/ValueSet/raceCategory-vistafrom this IG | |
| Patient2.maritalStatus | preferred | MaritalStatus_VistAhttp://va.gov/fhir/ValueSet/MaritalStatus-vistafrom this IG | |
| Patient2.religiousPreference | preferred | Religion_VistAhttp://va.gov/fhir/ValueSet/Religion-vistafrom this IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient2 |
0..* | Base | PATIENT (2) Instances of this logical model can be the target of a Reference | |
| integrationControlNumber |
0..1 | Element | INTEGRATION CONTROL NUMBER (-991.01) | |
| name |
0..1 | Element | NAME (-.01) | |
| phoneNumberResidence |
0..1 | Element | PHONE NUMBER [RESIDENCE] (-.131) | |
| phoneNumberWork |
0..1 | Element | PHONE NUMBER [WORK] (-.132) | |
| phoneNumberCellular |
0..1 | Element | PHONE NUMBER [CELLULAR] (-.134) | |
| dateOfBirth |
0..1 | Element | DATE OF BIRTH (-.03) | |
| dateOfDeath |
0..1 | Element | DATE OF DEATH (-.351) | |
| streetAddressLine1 |
0..1 | Element | STREET ADDRESS [LINE 1] (-.111) | |
| streetAddressLine2 |
0..1 | Element | STREET ADDRESS [LINE 2] (-.112) | |
| streetAddressLine3 |
0..1 | Element | STREET ADDRESS [LINE 3] (-.113) | |
| city |
0..1 | Element | CITY (-.114) | |
| state |
0..1 | Element | STATE (-.115) | |
| zip4 |
0..1 | Element | ZIP+4 (-.1112) | |
| country |
0..1 | Element | COUNTRY (-.1173) | |
| temporaryAddressStartDate |
0..1 | Element | TEMPORARY ADDRESS START DATE (-.1217) | |
| temporaryAddressEndDate |
0..1 | Element | TEMPORARY ADDRESS END DATE (-.1218) | |
| languageDatetime |
0..1 | Reference(LANGUAGE DATE/TIME (2.07)) | LANGUAGE DATE/TIME (-7) | |
| sex |
0..1 | Coding | SEX (-.02) Binding: adminGender VistA (preferred) | |
| selfIdentifiedGender |
0..1 | Coding | SELF IDENTIFIED GENDER (-.024) Binding: genderIdentity VistA (preferred) | |
| ethnicityInformation |
0..1 | Coding | ETHNICITY INFORMATION (-6) Binding: ethnicityCategory VistA (preferred) | |
| raceInformation |
0..1 | Coding | RACE INFORMATION (-2) Binding: raceCategory VistA (preferred) | |
| maritalStatus |
0..1 | Coding | MARITAL STATUS (-.05) Binding: MaritalStatus VistA (preferred) | |
| religiousPreference |
0..1 | Coding | RELIGIOUS PREFERENCE (-.08) Binding: Religion VistA (preferred) | |
| appointment |
0..1 | Element | APPOINTMENT (-1900) | |
| laboratoryReference |
0..1 | Reference(LAB DATA (63)) | LABORATORY REFERENCE (-63) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Patient2.sex | preferred | AdminGender_VistAhttp://va.gov/fhir/ValueSet/adminGender-vistafrom this IG | |
| Patient2.selfIdentifiedGender | preferred | GenderIdentity_VistAhttp://va.gov/fhir/ValueSet/genderIdentity-vistafrom this IG | |
| Patient2.ethnicityInformation | preferred | EthnicityCategory_VistAhttp://va.gov/fhir/ValueSet/ethnicityCategory-vistafrom this IG | |
| Patient2.raceInformation | preferred | RaceCategory_VistAhttp://va.gov/fhir/ValueSet/raceCategory-vistafrom this IG | |
| Patient2.maritalStatus | preferred | MaritalStatus_VistAhttp://va.gov/fhir/ValueSet/MaritalStatus-vistafrom this IG | |
| Patient2.religiousPreference | preferred | Religion_VistAhttp://va.gov/fhir/ValueSet/Religion-vistafrom this IG |
This structure is derived from Base