US Veterans Health Administration FHIR Map Set Implementation Guide
1.3.1 - 250401
Publication Build: This will be filled in by the publication tooling
Active as of 2025-03-31 |
Mappings for the DocumentReferenceDocumentReference resource profile.
Scroll down for the Raw FHIR, CDW & SDA mappings (if any).
Note that the CDW and SDA mappings are derived from a look-up based on the VistA source mappings in CDW and VPR SDA.
key | status | direction | source | mapApproach | mapCase | FHIR Path | subPath | mapValue | mapParameter | mapComment | FHIR URL | Ver |
---|---|---|---|---|---|---|---|---|---|---|---|
870 | team-approved | V2F | target not supported | DocumentReference.masterIdentifier | Not Must Support | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | |||||
871 | team-approved | V2F | TIU DOCUMENT - IEN (8925-.001) | source value | DocumentReference.identifier | .system = http://va.gov/identifiers/$Sta3n/8925 | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | ||||
871-1 | team-approved | V2F | fixed value | DocumentReference.identifier | .system | http://va.gov/identifiers/$Sta3n/8925 | generated from mapParameter line 1 | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | |||
874 | team-approved | V2F | TIU DOCUMENT - DOCUMENT TYPE > TIU DOCUMENT DEFINITION - VHA ENTERPRISE STANDARD TITLE > TIU VHA ENTERPRISE STANDARD TITLE (8925-.01 > 8925.1-1501 > 8926.1) | source value | DocumentReference.type | .coding.system=http://loinc.org .coding.code={CODING SYSTEM(2)} .text={DOCUMENT TYPE(.08)} |
Get LOINC from VistA or use TIU_VHA_ENTERPRISE_STANDARD_TITLE_8926.1 file provided by KBS to look up LOINC mapping CDW now has a view. N.B. CODING SYSTEM(2) is always LOINC codes! | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | |||
874-1 | team-approved | V2F | fixed value | DocumentReference.type | .coding.system | http://loinc.org | generated from mapParameter line 1 | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | |||
874-2 | team-approved | V2F | TIU DOCUMENT - DOCUMENT TYPE > TIU DOCUMENT DEFINITION - VHA ENTERPRISE STANDARD TITLE > TIU VHA ENTERPRISE STANDARD TITLE - CODING SYSTEM (8925-.01 > 8925.1-1501 > 8926.1-2) | source value | DocumentReference.type | .coding.code | generated from mapParameter line 2 | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | |||
874-3 | team-approved | V2F | TIU DOCUMENT - DOCUMENT TYPE > TIU DOCUMENT DEFINITION - VHA ENTERPRISE STANDARD TITLE > TIU VHA ENTERPRISE STANDARD TITLE - DOCUMENT TYPE (8925-.01 > 8925.1-1501 > 8926.1-.08) | source value | DocumentReference.type | .text | generated from mapParameter line 3 | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | |||
875 | for review | V2F | fixed value | DocumentReference.category[us-core] | http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category#clinical-note | (= NOTE, ADDENDUM, CONSULT, etc.?) Use TIU_VHA_ENTERPRISE_STANDARD_TITLE_8926.1 file provided by KBS to look up DocType If the document has a type or parent value, use that for the category | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | ||||
876 | team-approved | V2F | TIU DOCUMENT - PATIENT > PATIENT/IHS - NAME (8925-.02 > 9000001-.01) | reference | DocumentReference.subject | /Patient | Pointer to PATIENT/HIS FILE (#9000001) | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | |||
877 | team-approved | V2F | transform | DocumentReference.date | Resource_creation_time() | looking into façade pattern guidance on whether this is meaningful. 03/6/23 updated mapping based on LHV feedback | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | ||||
878 | team-approved | V2F | TIU DOCUMENT - AUTHOR/DICTATOR (8925-1202) | reference | DocumentReference.author | /Practitioner | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | ||||
1663 | for review | V2F | TIU DOCUMENT - SIGNED BY (8925-1502) | reference | DocumentReference.author | /Practitioner | Added signed by as an author since it allows more than one. | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | |||
879 | team-approved | V2F | TIU DOCUMENT - VERIFIED BY (8925-1306) | reference | DocumentReference.authenticator | /Practitioner | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | ||||
880 | team-approved | V2F | TIU DOCUMENT - DIVISION (8925-1212) | reference | DocumentReference.custodian | /Organization | who maintains the document = VA…. Or maybe a specific? Clinic Per 03/02/2023 email from LH, changed the Vista field from 1205 (hospital location) to 1212 (division). | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | |||
885 | team-approved | V2F | TIU DOCUMENT - SUBJECT (OPTIONAL description) (8925-1701) | source value | DocumentReference.description | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | |||||
886 | team-approved | V2F | target not supported | DocumentReference.securityLabel | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | ||||||
887 | team-approved | V2F | target not supported | DocumentReference.content.id | remove | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | |||||
888 | team-approved | V2F | TIU DOCUMENT - IEN (8925-.001) | source value | DocumentReference.content.attachment.id | keep. Using HDR to pull text; need this | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | ||||
889 | team-approved | V2F | fixed value | DocumentReference.content.attachment.contentType | #text/plain | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | |||||
890 | team-approved | V2F | target not supported | DocumentReference.content.attachment.language | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | ||||||
892 | team-approved | V2F | TIU DOCUMENT - REPORT TEXT (8925-2) | transform | DocumentReference.content.attachment.url | create(Binary) | option 2: USED in PHAPI US Core: DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | |||
893 | team-approved | V2F | TIU DOCUMENT - REPORT TEXT (8925-2) | transform | DocumentReference.content.attachment.size | calculate() | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | ||||
894 | team-approved | V2F | TIU DOCUMENT - REPORT TEXT (8925-2) | transform | DocumentReference.content.attachment.hash | calculate() | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | ||||
895 | team-approved | V2F | TIU DOCUMENT - DOCUMENT TYPE > TIU DOCUMENT DEFINITION - VHA ENTERPRISE STANDARD TITLE > TIU VHA ENTERPRISE STANDARD TITLE - STANDARD TITLE (8925-.01 > 8925.1-1501 > 8926.1-.01) | source value | DocumentReference.content.attachment.title | 03/06/23 added the secondary subfield based on LH feedback | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | ||||
896 | team-approved | V2F | TIU DOCUMENT - ENTRY DATE/TIME (8925-1201) | source value | DocumentReference.content.attachment.creation | .07 does not indicate parent or child document only the treatment episode associated with document | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | ||||
897 | team-approved | V2F | target not supported | DocumentReference.content.format | These are specific document types, mostly IHE, not MIME | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | |||||
898 | team-approved | V2F | target not supported | DocumentReference.context.id | Or ad hoc, for transient assets | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | |||||
899 | team-approved | V2F | TIU DOCUMENT - VISIT (8925-.03) | reference | DocumentReference.context.encounter | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | |||||
900 | team-approved | V2F | TIU DOCUMENT - VISIT TYPE (8925-.13) | source value | DocumentReference.context.event | candidate: 8925-.13 | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | ||||
901 | team-approved | V2F | TIU DOCUMENT - EPISODE BEGIN DATE/TIME (8925-.07) | source value | DocumentReference.context.period | .start | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | ||||
902 | team-approved | V2F | TIU DOCUMENT - EPISODE END DATE/TIME (8925-.08) | source value | DocumentReference.context.period | .end | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | ||||
903 | team-approved | V2F | TIU DOCUMENT - HOSPITAL LOCATION > HOSPITAL LOCATION - TYPE (8925-1205 > 44-2) | source value | DocumentReference.context.facilityType | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | |||||
904 | team-approved | V2F | TIU DOCUMENT - TREATING SPECIALTY (8925-1402) | source value | DocumentReference.context.practiceSetting | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | |||||
905 | team-approved | V2F | target not supported | DocumentReference.context.sourcePatientInfo | a snapshot of patient at time of document | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 | |||||
906 | team-approved | V2F | target not supported | DocumentReference.context.related | other related assets | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | 5.0.1 |
DocumentReferenceDocumentReference | ||
DocumentReference | ||
masterIdentifier | 870: target not supported | Not Must Support |
identifier | 871: source value based on TIU DOCUMENT - IEN (8925-.001) | |
system | 871-1: fixed value = http://va.gov/identifiers/$Sta3n/8925 | generated from mapParameter line 1 |
type | 874: source value based on TIU DOCUMENT - DOCUMENT TYPE > TIU DOCUMENT DEFINITION - VHA ENTERPRISE STANDARD TITLE > TIU VHA ENTERPRISE STANDARD TITLE (8925-.01 > 8925.1-1501 > 8926.1) | Get LOINC from VistA or use TIU_VHA_ENTERPRISE_STANDARD_TITLE_8926.1 file provided by KBS to look up LOINC mapping CDW now has a view. N.B. CODING SYSTEM(2) is always LOINC codes! |
coding | ||
system | 874-1: fixed value = http://loinc.org | generated from mapParameter line 1 |
code | 874-2: source value based on TIU DOCUMENT - DOCUMENT TYPE > TIU DOCUMENT DEFINITION - VHA ENTERPRISE STANDARD TITLE > TIU VHA ENTERPRISE STANDARD TITLE - CODING SYSTEM (8925-.01 > 8925.1-1501 > 8926.1-2) | generated from mapParameter line 2 |
text | 874-3: source value based on TIU DOCUMENT - DOCUMENT TYPE > TIU DOCUMENT DEFINITION - VHA ENTERPRISE STANDARD TITLE > TIU VHA ENTERPRISE STANDARD TITLE - DOCUMENT TYPE (8925-.01 > 8925.1-1501 > 8926.1-.08) | generated from mapParameter line 3 |
category (us-core) | 875: fixed value = http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category#clinical-note | (= NOTE, ADDENDUM, CONSULT, etc.?) Use TIU_VHA_ENTERPRISE_STANDARD_TITLE_8926.1 file provided by KBS to look up DocType If the document has a type or parent value, use that for the category |
subject | 876: reference based on TIU DOCUMENT - PATIENT > PATIENT/IHS - NAME (8925-.02 > 9000001-.01) | Pointer to PATIENT/HIS FILE (#9000001) |
date | 877: transform using Resource_creation_time() | looking into façade pattern guidance on whether this is meaningful. 03/6/23 updated mapping based on LHV feedback |
author | 878: reference based on TIU DOCUMENT - AUTHOR/DICTATOR (8925-1202), 1663: reference based on TIU DOCUMENT - SIGNED BY (8925-1502) | , Added signed by as an author since it allows more than one. |
authenticator | 879: reference based on TIU DOCUMENT - VERIFIED BY (8925-1306) | |
custodian | 880: reference based on TIU DOCUMENT - DIVISION (8925-1212) | who maintains the document = VA…. Or maybe a specific? Clinic Per 03/02/2023 email from LH, changed the Vista field from 1205 (hospital location) to 1212 (division). |
description | 885: source value based on TIU DOCUMENT - SUBJECT (OPTIONAL description) (8925-1701) | |
securityLabel | 886: target not supported | |
content | ||
id | 887: target not supported | remove |
attachment | ||
id | 888: source value based on TIU DOCUMENT - IEN (8925-.001) | keep. Using HDR to pull text; need this |
contentType | 889: fixed value = #text/plain | |
language | 890: target not supported | |
url | 892: transform using create(Binary) on TIU DOCUMENT - REPORT TEXT (8925-2) | option 2: USED in PHAPI US Core: DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. |
size | 893: transform using calculate() on TIU DOCUMENT - REPORT TEXT (8925-2) | |
hash | 894: transform using calculate() on TIU DOCUMENT - REPORT TEXT (8925-2) | |
title | 895: source value based on TIU DOCUMENT - DOCUMENT TYPE > TIU DOCUMENT DEFINITION - VHA ENTERPRISE STANDARD TITLE > TIU VHA ENTERPRISE STANDARD TITLE - STANDARD TITLE (8925-.01 > 8925.1-1501 > 8926.1-.01) | 03/06/23 added the secondary subfield based on LH feedback |
creation | 896: source value based on TIU DOCUMENT - ENTRY DATE/TIME (8925-1201) | .07 does not indicate parent or child document only the treatment episode associated with document |
format | 897: target not supported | These are specific document types, mostly IHE, not MIME |
context | ||
id | 898: target not supported | Or ad hoc, for transient assets |
encounter | 899: reference based on TIU DOCUMENT - VISIT (8925-.03) | |
event | 900: source value based on TIU DOCUMENT - VISIT TYPE (8925-.13) | candidate: 8925-.13 |
period | ||
start | 901: source value based on TIU DOCUMENT - EPISODE BEGIN DATE/TIME (8925-.07) | |
end | 902: source value based on TIU DOCUMENT - EPISODE END DATE/TIME (8925-.08) | |
facilityType | 903: source value based on TIU DOCUMENT - HOSPITAL LOCATION > HOSPITAL LOCATION - TYPE (8925-1205 > 44-2) | |
practiceSetting | 904: source value based on TIU DOCUMENT - TREATING SPECIALTY (8925-1402) | |
sourcePatientInfo | 905: target not supported | a snapshot of patient at time of document |
related | 906: target not supported | other related assets |
DocumentReferenceDocumentReference | ||
DocumentReference | ||
type | TIU.TIUDocument.TIUDocumentDefinitionIEN | |
coding | ||
code | TIU.TIUDocument.TIUDocumentDefinitionIEN | |
text | TIU.TIUDocument.TIUDocumentDefinitionIEN | |
subject | TIU.TIUDocument.PatientIEN | |
author | TIU.TIUDocument.AuthorDictatorStaffIEN, TIU.TIUDocument.SignedByStaffIEN | |
authenticator | TIU.TIUDocument.VerifiedByStaffIEN | |
custodian | TIU.TIUDocument.InstitutionIEN | |
description | TIU.TIUDocument.DocumentSubject | |
content | ||
attachment | ||
title | TIU.TIUDocument.TIUDocumentDefinitionIEN | |
creation | TIU.TIUDocument.EntryDateTime | |
context | ||
encounter | TIU.TIUDocument.VisitIEN | |
event | TIU.TIUDocument.VisitType | |
period | ||
start | TIU.TIUDocument.EpisodeBeginDateTime | |
end | TIU.TIUDocument.EpisodeEndDateTime | |
facilityType | TIU.TIUDocument.DocumentLocationIEN Dim.Location.LocationType,Dim.Location.LocationType | |
practiceSetting | TIU.TIUDocument.TreatingSpecialtyIEN |
DocumentReferenceDocumentReference | ||
DocumentReference | ||
type | AdvanceDirective.Alert,AdvanceDirective.Status,Alert.Alert,Alert.AlertType,Documents.DocumentName,Documents.DocumentType,Documents.Extension[DocumentExtension].NationalTitle,Documents.Extension[DocumentExtension].NationalTitleRole,Documents.Extension[DocumentExtension].NationalTitleService,Documents.Extension[DocumentExtension].NationalTitleSetting,Documents.Extension[DocumentExtension].NationalTitleSubject,Documents.Extension[DocumentExtension].NationalTitleType,Documents.DocumentCompletionStatus.Description,Documents.DocumentClass[VA.DocumentClass].Description,Documents.NationalTitle[VA.NationalTitle].Description,Documents.NationalTitleRole[VA.NationalTitleRole].Description,Documents.NationalTitleService[VA.NationalTitleService].Description,Documents.NationalTitleSetting[VA.NationalTitleSetting].Description,Documents.NationalTitleSubject[VA.NationalTitleSubject].Description,Documents.NationalTitleType[VA.NationalTitleType].Description,Documents.CareProvider.Description,Documents.CareProvider.Name | |
coding | ||
code | AdvanceDirective.Alert,AdvanceDirective.Status,Alert.Alert,Alert.AlertType,Documents.DocumentName,Documents.DocumentType,Documents.Extension[DocumentExtension].NationalTitle,Documents.Extension[DocumentExtension].NationalTitleRole,Documents.Extension[DocumentExtension].NationalTitleService,Documents.Extension[DocumentExtension].NationalTitleSetting,Documents.Extension[DocumentExtension].NationalTitleSubject,Documents.Extension[DocumentExtension].NationalTitleType,Documents.DocumentCompletionStatus.Description,Documents.DocumentClass[VA.DocumentClass].Description,Documents.NationalTitle[VA.NationalTitle].Description,Documents.NationalTitleRole[VA.NationalTitleRole].Description,Documents.NationalTitleService[VA.NationalTitleService].Description,Documents.NationalTitleSetting[VA.NationalTitleSetting].Description,Documents.NationalTitleSubject[VA.NationalTitleSubject].Description,Documents.NationalTitleType[VA.NationalTitleType].Description,Documents.CareProvider.Description,Documents.CareProvider.Name | |
text | AdvanceDirective.Alert,AdvanceDirective.Status,Alert.Alert,Alert.AlertType,Documents.DocumentName,Documents.DocumentType,Documents.Extension[DocumentExtension].NationalTitle,Documents.Extension[DocumentExtension].NationalTitleRole,Documents.Extension[DocumentExtension].NationalTitleService,Documents.Extension[DocumentExtension].NationalTitleSetting,Documents.Extension[DocumentExtension].NationalTitleSubject,Documents.Extension[DocumentExtension].NationalTitleType,Documents.DocumentCompletionStatus.Description,Documents.DocumentClass[VA.DocumentClass].Description,Documents.NationalTitle[VA.NationalTitle].Description,Documents.NationalTitleRole[VA.NationalTitleRole].Description,Documents.NationalTitleService[VA.NationalTitleService].Description,Documents.NationalTitleSetting[VA.NationalTitleSetting].Description,Documents.NationalTitleSubject[VA.NationalTitleSubject].Description,Documents.NationalTitleType[VA.NationalTitleType].Description,Documents.CareProvider.Description,Documents.CareProvider.Name | |
subject | Documents.DocumentType | |
author | Alert.EnteredBy, Documents.Extension[DocumentExtension].CareProviders | |
custodian | AdvanceDirective.EnteredAt,Documents.EnteredAt | |
description | Documents.Extension[DocumentExtension].Subject | |
content | ||
attachment | ||
url | AdvanceDirective.Comments,Alert.Comments,Documents.NoteText | |
size | AdvanceDirective.Comments,Alert.Comments,Documents.NoteText | |
hash | AdvanceDirective.Comments,Alert.Comments,Documents.NoteText | |
title | AdvanceDirective.Alert,AdvanceDirective.Status,Alert.Alert,Alert.AlertType,Documents.DocumentName,Documents.DocumentType,Documents.Extension[DocumentExtension].NationalTitle,Documents.Extension[DocumentExtension].NationalTitleRole,Documents.Extension[DocumentExtension].NationalTitleService,Documents.Extension[DocumentExtension].NationalTitleSetting,Documents.Extension[DocumentExtension].NationalTitleSubject,Documents.Extension[DocumentExtension].NationalTitleType,Documents.DocumentCompletionStatus.Description,Documents.DocumentClass[VA.DocumentClass].Description,Documents.NationalTitle[VA.NationalTitle].Description,Documents.NationalTitleRole[VA.NationalTitleRole].Description,Documents.NationalTitleService[VA.NationalTitleService].Description,Documents.NationalTitleSetting[VA.NationalTitleSetting].Description,Documents.NationalTitleSubject[VA.NationalTitleSubject].Description,Documents.NationalTitleType[VA.NationalTitleType].Description,Documents.CareProvider.Description,Documents.CareProvider.Name | |
context | ||
encounter | AdvanceDirective.EncounterNumber,Alert.EncounterNumber,Documents.EncounterNumber | |
facilityType | Alert.EnteredAt,Documents.Extension[DocumentExtension].PatientLocation |
DocumentReferenceDocumentReference | ||
DocumentReference | Event | |
masterIdentifier | Event.identifier | |
identifier | Event.identifier | |
status | Event.status | |
type | Event.code | |
subject | Event.subject | |
date | Event.occurrence[x] | |
author | Event.performer.actor | |
authenticator | Event.performer.actor | |
custodian | Event.performer.actor | |
context | ||
encounter | Event.context |
DocumentReferenceDocumentReference | ||
DocumentReference | when describing a Composition | |
masterIdentifier | Composition.identifier | |
docStatus | Composition.status | |
type | Composition.type | |
category | Composition.class | |
category (us-core) | Composition.class | |
subject | Composition.subject | |
date | Composition.date | |
author | Composition.author | |
authenticator | Composition.attester | |
custodian | Composition.custodian | |
relatesTo | Composition.relatesTo | |
code | Composition.relatesTo.code | |
target | Composition.relatesTo.target | |
securityLabel | Composition.confidentiality, Composition.meta.security | |
content | Bundle(Composition+*) | |
attachment | Composition.language, Composition.title, Composition.date | |
format | Composition.meta.profile | |
context | ||
encounter | Composition.encounter | |
event | Composition.event.code | |
period | Composition.event.period | |
facilityType | usually from a mapping to a local ValueSet | |
practiceSetting | usually from a mapping to a local ValueSet | |
sourcePatientInfo | Composition.subject | |
related | Composition.event.detail |
DocumentReferenceDocumentReference | ||
DocumentReference | Entity. Role, or Act, Document[classCode="DOC" and moodCode="EVN"] | |
text | Act.text? | |
contained | N/A | |
extension | N/A | |
modifierExtension | N/A | |
masterIdentifier | .id | |
identifier | .id / .setId | |
id | n/a | |
extension | n/a | |
use | Role.code or implied by context | |
type | Role.code or implied by context | |
system | II.root or Role.id.root | |
value | II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) | |
period | Role.effectiveTime or implied by context | |
assigner | II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper | |
status | interim: .completionCode="IN" & ./statusCode[isNormalDatatype()]="active"; final: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and not(./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseDocument", code) and isNormalAct()]); amended: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and ./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseDocument", code) and isNormalAct() and statusCode="completed"]; withdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]="obsolete" | |
docStatus | .statusCode | |
type | ./code | |
id | n/a | |
extension | n/a | |
coding | union(., ./translation) | |
id | n/a | |
extension | n/a | |
system | ./codeSystem | |
version | ./codeSystemVersion | |
code | ./code | |
display | CV.displayName | |
userSelected | CD.codingRationale | |
text | ./originalText[mediaType/code="text/plain"]/data | |
category | .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code | |
category (us-core) | .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code | |
subject | .participation[typeCode="SBJ"].role[typeCode="PAT"] | |
date | .availabilityTime[type="TS"] | |
author | .participation[typeCode="AUT"].role[classCode="ASSIGNED"] | |
authenticator | .participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"] | |
custodian | .participation[typeCode="RCV"].role[classCode="CUST"].scoper[classCode="ORG" and determinerCode="INST"] | |
relatesTo | .outboundRelationship | |
id | n/a | |
extension | n/a | |
modifierExtension | N/A | |
code | .outboundRelationship.typeCode | |
target | .target[classCode="DOC", moodCode="EVN"].id | |
description | .outboundRelationship[typeCode="SUBJ"].target.text | |
securityLabel | .confidentialityCode | |
content | document.text | |
id | n/a | |
extension | n/a | |
modifierExtension | N/A | |
attachment | document.text | |
id | n/a | |
extension | n/a | |
contentType | ./mediaType, ./charset | |
language | ./language | |
data | ./data | |
url | ./reference/literal | |
size | N/A (needs data type R3 proposal) | |
hash | .integrityCheck[parent::ED/integrityCheckAlgorithm="SHA-1"] | |
title | ./title/data | |
creation | N/A (needs data type R3 proposal) | |
format | document.text | |
context | outboundRelationship[typeCode="SUBJ"].target[classCode<'ACT'] | |
id | n/a | |
extension | n/a | |
modifierExtension | N/A | |
encounter | unique(highest(./outboundRelationship[typeCode="SUBJ" and isNormalActRelationship()], priorityNumber)/target[moodCode="EVN" and classCode=("ENC", "PCPR") and isNormalAct]) | |
event | .code | |
period | .effectiveTime | |
id | n/a | |
extension | n/a | |
start | ./low | |
end | ./high | |
facilityType | .participation[typeCode="LOC"].role[classCode="DSDLOC"].code | |
practiceSetting | .participation[typeCode="LOC"].role[classCode="DSDLOC"].code | |
sourcePatientInfo | .participation[typeCode="SBJ"].role[typeCode="PAT"] | |
related | ./outboundRelationship[typeCode="PERT" and isNormalActRelationship()] / target[isNormalAct] |
DocumentReferenceDocumentReference | ||
DocumentReference | when describing a CDA | |
masterIdentifier | ClinicalDocument/id | |
type | ClinicalDocument/code/@code The typeCode should be mapped from the ClinicalDocument/code element to a set of document type codes configured in the affinity domain. One suggested coding system to use for typeCode is LOINC, in which case the mapping step can be omitted. | |
category | Derived from a mapping of /ClinicalDocument/code/@code to an Affinity Domain specified coded value to use and coding system. Affinity Domains are encouraged to use the appropriate value for Type of Service, based on the LOINC Type of Service (see Page 53 of the LOINC User's Manual). Must be consistent with /ClinicalDocument/code/@code | |
category (us-core) | Derived from a mapping of /ClinicalDocument/code/@code to an Affinity Domain specified coded value to use and coding system. Affinity Domains are encouraged to use the appropriate value for Type of Service, based on the LOINC Type of Service (see Page 53 of the LOINC User's Manual). Must be consistent with /ClinicalDocument/code/@code | |
subject | ClinicalDocument/recordTarget/ | |
author | ClinicalDocument/author | |
authenticator | ClinicalDocument/legalAuthenticator | |
securityLabel | ClinicalDocument/confidentialityCode/@code | |
content | ||
attachment | ClinicalDocument/languageCode, ClinicalDocument/title, ClinicalDocument/date | |
format | derived from the IHE Profile or Implementation Guide templateID | |
context | ||
period | ClinicalDocument/documentationOf/ serviceEvent/effectiveTime/low/ @value --> ClinicalDocument/documentationOf/ serviceEvent/effectiveTime/high/ @value | |
facilityType | usually a mapping to a local ValueSet. Must be consistent with /clinicalDocument/code | |
practiceSetting | usually from a mapping to a local ValueSet | |
sourcePatientInfo | ClinicalDocument/recordTarget/ | |
related | ClinicalDocument/relatedDocument |
DocumentReferenceDocumentReference | ||
DocumentReference | ||
masterIdentifier | FiveWs.identifier | |
identifier | FiveWs.identifier | |
status | FiveWs.status | |
docStatus | FiveWs.status | |
type | FiveWs.class | |
category | FiveWs.class | |
category (us-core) | FiveWs.class | |
subject | FiveWs.subject[x], FiveWs.subject | |
date | FiveWs.recorded | |
authenticator | FiveWs.witness | |
context | ||
encounter | FiveWs.context |
DocumentReferenceDocumentReference | ||
DocumentReference | ||
masterIdentifier | TXA-12 | |
identifier | TXA-16? | |
use | N/A | |
type | CX.5 | |
system | CX.4 / EI-2-4 | |
value | CX.1 / EI.1 | |
period | CX.7 + CX.8 | |
assigner | CX.4 / (CX.4,CX.9,CX.10) | |
status | TXA-19 | |
docStatus | TXA-17 | |
type | TXA-2 | |
coding | C*E.1-8, C*E.10-22 | |
system | C*E.3 | |
version | C*E.7 | |
code | C*E.1 | |
display | C*E.2 - but note this is not well followed | |
userSelected | Sometimes implied by being first | |
text | C*E.9. But note many systems use C*E.2 for this | |
subject | PID-3 (No standard way to define a Practitioner or Group subject in HL7 v2 MDM message) | |
author | TXA-9 (No standard way to indicate a Device in HL7 v2 MDM message) | |
authenticator | TXA-10 | |
description | TXA-25 | |
securityLabel | TXA-18 | |
content | ||
attachment | TXA-3 for mime type | |
contentType | ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used | |
data | ED.5 | |
url | RP.1+RP.2 - if they refer to a URL (see v2.6) | |
context | ||
period | ||
start | DR.1 | |
end | DR.2 |
DocumentReferenceDocumentReference | ||
DocumentReference | ||
masterIdentifier | DocumentEntry.uniqueId | |
identifier | DocumentEntry.entryUUID | |
status | DocumentEntry.availabilityStatus | |
type | DocumentEntry.type | |
category | DocumentEntry.class | |
category (us-core) | DocumentEntry.class | |
subject | DocumentEntry.patientId | |
author | DocumentEntry.author | |
authenticator | DocumentEntry.legalAuthenticator | |
relatesTo | DocumentEntry Associations | |
code | DocumentEntry Associations type | |
target | DocumentEntry Associations reference | |
description | DocumentEntry.comments | |
securityLabel | DocumentEntry.confidentialityCode | |
content | ||
attachment | DocumentEntry.mimeType, DocumentEntry.languageCode, DocumentEntry.URI, DocumentEntry.size, DocumentEntry.hash, DocumentEntry.title, DocumentEntry.creationTime | |
format | DocumentEntry.formatCode | |
context | ||
event | DocumentEntry.eventCodeList | |
period | DocumentEntry.serviceStartTime, DocumentEntry.serviceStopTime | |
facilityType | DocumentEntry.healthcareFacilityTypeCode | |
practiceSetting | DocumentEntry.practiceSettingCode | |
sourcePatientInfo | DocumentEntry.sourcePatientInfo, DocumentEntry.sourcePatientId | |
related | DocumentEntry.referenceIdList |