NGS IG - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Mappings for the DocumentReference-twngs resource profile.
| DocumentReferenceTWNGS |
| DocumentReference | Entity. Role, or Act, Document[classCode="DOC" and moodCode="EVN"] |
| meta | n/a, N/A |
| implicitRules | n/a |
| language | n/a |
| text | n/a, N/A, Act.text? |
| contained | Entity. Role, or Act, N/A |
| extension | n/a, N/A |
| modifierExtension | n/a, N/A |
| masterIdentifier | n/a, II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT], .id |
| identifier | n/a, II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT], .id / .setId |
| status | n/a, 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 | n/a, .statusCode |
| type | n/a, CD, ./code |
| id | n/a |
| extension | n/a, N/A |
| coding | n/a, CV, union(., ./translation) |
| id | n/a |
| extension | n/a, N/A |
| system | n/a, ./codeSystem |
| version | n/a, ./codeSystemVersion |
| code | n/a, ./code |
| display | n/a, CV.displayName |
| userSelected | n/a, CD.codingRationale |
| text | n/a, ./originalText[mediaType/code="text/plain"]/data |
| category | n/a, CD, .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code |
| id | n/a |
| extension | n/a, N/A |
| coding | n/a, CV, union(., ./translation) |
| id | n/a |
| extension | n/a, N/A |
| system | n/a, ./codeSystem |
| version | n/a, ./codeSystemVersion |
| code | n/a, ./code |
| display | n/a, CV.displayName |
| userSelected | n/a, CD.codingRationale |
| text | n/a, ./originalText[mediaType/code="text/plain"]/data |
| subject | n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), .participation[typeCode="SBJ"].role[typeCode="PAT"] |
| date | n/a, .availabilityTime[type="TS"] |
| author | n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), .participation[typeCode="AUT"].role[classCode="ASSIGNED"] |
| authenticator | n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), .participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"] |
| custodian | n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), .participation[typeCode="RCV"].role[classCode="CUST"].scoper[classCode="ORG" and determinerCode="INST"] |
| relatesTo | n/a, .outboundRelationship |
| id | n/a |
| extension | n/a, N/A |
| modifierExtension | n/a, N/A |
| code | n/a, .outboundRelationship.typeCode |
| target | n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), .target[classCode="DOC", moodCode="EVN"].id |
| description | n/a, .outboundRelationship[typeCode="SUBJ"].target.text |
| securityLabel | n/a, CD, .confidentialityCode |
| id | n/a |
| extension | n/a, N/A |
| coding | n/a, CV, union(., ./translation) |
| id | n/a |
| extension | n/a, N/A |
| system | n/a, ./codeSystem |
| version | n/a, ./codeSystemVersion |
| code | n/a, ./code |
| display | n/a, CV.displayName |
| userSelected | n/a, CD.codingRationale |
| text | n/a, ./originalText[mediaType/code="text/plain"]/data |
| content | n/a, document.text |
| id | n/a |
| extension | n/a, N/A |
| modifierExtension | n/a, N/A |
| attachment | n/a, ED, document.text |
| id | n/a |
| extension | n/a, N/A |
| contentType | n/a, ./mediaType, ./charset |
| language | n/a, ./language |
| data | n/a, ./data |
| url | n/a, ./reference/literal |
| size | n/a, N/A (needs data type R3 proposal) |
| hash | n/a, .integrityCheck[parent::ED/integrityCheckAlgorithm="SHA-1"] |
| title | n/a, ./title/data |
| creation | n/a, N/A (needs data type R3 proposal) |
| format | n/a, CV, document.text |
| context | n/a, outboundRelationship[typeCode="SUBJ"].target[classCode<'ACT'] |
| id | n/a |
| extension | n/a, N/A |
| modifierExtension | n/a, N/A |
| encounter | n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), unique(highest(./outboundRelationship[typeCode="SUBJ" and isNormalActRelationship()], priorityNumber)/target[moodCode="EVN" and classCode=("ENC", "PCPR") and isNormalAct]) |
| event | n/a, CD, .code |
| id | n/a |
| extension | n/a, N/A |
| coding | n/a, CV, union(., ./translation) |
| id | n/a |
| extension | n/a, N/A |
| system | n/a, ./codeSystem |
| version | n/a, ./codeSystemVersion |
| code | n/a, ./code |
| display | n/a, CV.displayName |
| userSelected | n/a, CD.codingRationale |
| text | n/a, ./originalText[mediaType/code="text/plain"]/data |
| period | n/a, IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"], .effectiveTime |
| facilityType | n/a, CD, .participation[typeCode="LOC"].role[classCode="DSDLOC"].code |
| practiceSetting | n/a, CD, .participation[typeCode="LOC"].role[classCode="DSDLOC"].code |
| id | n/a |
| extension | n/a, N/A |
| coding | n/a, CV, union(., ./translation) |
| id | n/a |
| extension | n/a, N/A |
| system | n/a, ./codeSystem |
| version | n/a, ./codeSystemVersion |
| code | n/a, ./code |
| display | n/a, CV.displayName |
| userSelected | n/a, CD.codingRationale |
| text | n/a, ./originalText[mediaType/code="text/plain"]/data |
| sourcePatientInfo | n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), .participation[typeCode="SBJ"].role[typeCode="PAT"] |
| related | n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), ./outboundRelationship[typeCode="PERT" and isNormalActRelationship()] / target[isNormalAct] |
| DocumentReferenceTWNGS |
| 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 |
| 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 |
| DocumentReferenceTWNGS |
| DocumentReference | |
| masterIdentifier | CX / EI (occasionally, more often EI maps to a resource id or a URL), TXA-12 |
| identifier | CX / EI (occasionally, more often EI maps to a resource id or a URL), TXA-16? |
| status | TXA-19 |
| docStatus | TXA-17 |
| type | CE/CNE/CWE, TXA-2 |
| coding | CE/CNE/CWE subset one of the sets of component 1-3 or 4-6, 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 |
| category | CE/CNE/CWE |
| coding | CE/CNE/CWE subset one of the sets of component 1-3 or 4-6, 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 | CE/CNE/CWE, TXA-18 |
| coding | CE/CNE/CWE subset one of the sets of component 1-3 or 4-6, 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 |
| content | |
| attachment | ED/RP, 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) |
| format | CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 |
| context | |
| event | CE/CNE/CWE |
| coding | CE/CNE/CWE subset one of the sets of component 1-3 or 4-6, 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 |
| period | DR |
| facilityType | CE/CNE/CWE |
| practiceSetting | CE/CNE/CWE |
| coding | CE/CNE/CWE subset one of the sets of component 1-3 or 4-6, 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 |
| DocumentReferenceTWNGS |
| DocumentReference | |
| masterIdentifier | DocumentEntry.uniqueId |
| identifier | DocumentEntry.entryUUID |
| status | DocumentEntry.availabilityStatus |
| type | DocumentEntry.type |
| category | 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 |