{
"description": "Used to capture Clinical Notes",
"_filename": "profile-documentReference.StructureDefinition.json",
"package_name": "ForgePatientChart.0830",
"date": "2021-03-01T20:09:56.9691901+00:00",
"derivation": "constraint",
"meta": {
"versionId": "1",
"lastUpdated": "2022-08-10T19:13:29.6466514+00:00"
},
"publisher": null,
"fhirVersion": "4.0.1",
"name": "DocumentReference",
"mapping": [ {
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern",
"identity": "workflow"
}, {
"uri": "http://hl7.org/fhir/composition",
"name": "FHIR Composition",
"identity": "fhircomposition"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/v3/cda",
"name": "CDA (R2)",
"identity": "cda"
}, {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
}, {
"uri": "http://ihe.net/xds",
"name": "XDS metadata equivalent",
"identity": "xds"
} ],
"abstract": false,
"type": "DocumentReference",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "DocumentReference",
"package_version": "0.1.0",
"status": "draft",
"id": "9f597161-63aa-4ed8-8c9b-70cbe7425b45",
"kind": "resource",
"url": "http://telus.com/fhir/patientChart/StructureDefinition/profile-clinical-note-documentReference",
"version": null,
"differential": {
"element": [ {
"id": "DocumentReference",
"path": "DocumentReference",
"comment": "Usage Notes: Clinical notes that are captured as free text in the EMR map nicely into this resource. If notes are captured in a more structured manner using templates, the questionnaire response is likely more appropriate. \r\n\r\nUsually, this is used for documents other than those defined by FHIR.",
"mustSupport": true
}, {
"id": "DocumentReference.id",
"path": "DocumentReference.id",
"comment": "Usage Note: This will usually be a GUID that is assigned by the sending application. \r\n\r\nThe only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"mustSupport": true
}, {
"id": "DocumentReference.meta",
"path": "DocumentReference.meta",
"mustSupport": true
}, {
"id": "DocumentReference.meta.lastUpdated",
"path": "DocumentReference.meta.lastUpdated",
"mustSupport": true
}, {
"id": "DocumentReference.meta.source",
"path": "DocumentReference.meta.source",
"mustSupport": true
}, {
"id": "DocumentReference.meta.profile",
"path": "DocumentReference.meta.profile",
"comment": "Usage: This will be determined by each implementation. This may be useful in validating message instances against this profile.\r\n\r\nIt is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.",
"mustSupport": true
}, {
"id": "DocumentReference.text",
"path": "DocumentReference.text",
"comment": "Conformance Rule: This must be formatted, as closely as possible what was presented to the user in the originating system and must include all clinical data. \r\n\r\nContained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"mustSupport": true
}, {
"id": "DocumentReference.text.status",
"path": "DocumentReference.text.status",
"mustSupport": true
}, {
"id": "DocumentReference.text.div",
"path": "DocumentReference.text.div",
"mustSupport": true
}, {
"id": "DocumentReference.identifier",
"max": "1",
"path": "DocumentReference.identifier",
"comment": "Conformance Rule: This will be populated with the business identifier; for example, DI Requisition Identifier assocaited with the attachment or Bundle when known.",
"mustSupport": true
}, {
"id": "DocumentReference.identifier.system",
"path": "DocumentReference.identifier.system",
"mustSupport": true
}, {
"id": "DocumentReference.identifier.value",
"path": "DocumentReference.identifier.value",
"mustSupport": true
}, {
"id": "DocumentReference.status",
"path": "DocumentReference.status",
"fixedCode": "current",
"definition": "The status of this document reference",
"mustSupport": true
}, {
"id": "DocumentReference.docStatus",
"path": "DocumentReference.docStatus",
"comment": "Usage: Draft and unfinished notes would be preliminary; Final is often used. Amended and entered-in-error would likely not be used\r\nUsage: If EMRs are able to provide it, this must be populated\r\n\r\nThe document that is pointed to might be in various lifecycle states.",
"mustSupport": true
}, {
"id": "DocumentReference.type",
"path": "DocumentReference.type",
"binding": {
"strength": "extensible",
"valueSet": "http://telus.com/fhir/ValueSet/telus-documentreference-type-category"
},
"comment": "Usage Note: Category should be specified when known. Typical categories are things like: Internal/EMR - physicals, general assessment, Admission history nd physical, Diabetic visit note, Follow-up Opiod addiction visit ** LOOK FOR LOINC CODES FOR THESE -- https://loinc.org/LG38741-1/\r\n\r\nUsage Note: This is used to identify the type of note/structure of the document, eg consultation, progress note, discharge summary etc. This may not identifiy the specialty (eg cardiology), however, if this is known (eg cardinalogy discharge summary) it should be included here. Note: The same code may be replicated in category. Example codes: https://fhir.loinc.org/ValueSet/?url=http://loinc.org/vs/LG39083-7\r\n\r\nConformance Rule: This must be specified when known. Set type to the best, most precise LOINC code corresponding to the concept of the document in the source system.\r\nConformance Rule: If available, a local code must be supplied as well (code, system, mandatory text, userSelected).\r\nExamples (US Core) - TELUS WILL NEED TO PUBLISH OUR OWN VALUE SET\r\n\r\nConsultation Note (11488-4)\r\nDischarge Summary (18842-5)\r\nHistory & Physical Note (34117-2)\r\nProcedures Note (28570-0)\r\nProgress Note (11506-3)\r\nNote (34109-9)\r\n\r\n\r\nUsage Note: In future releases, a full set of LOINC codes (including LOINC.Ontology codes) will be added to this value set. Implementers should expect that this value set will be provided outside of the specification. This will not be populated on messages that originate from sending systems on an earlier May 2016 version.",
"mustSupport": true
}, {
"id": "DocumentReference.type.coding",
"max": "5",
"path": "DocumentReference.type.coding",
"mustSupport": true
}, {
"id": "DocumentReference.type.coding.system",
"min": 1,
"path": "DocumentReference.type.coding.system",
"mustSupport": true
}, {
"id": "DocumentReference.type.coding.code",
"min": 1,
"path": "DocumentReference.type.coding.code",
"mustSupport": true
}, {
"id": "DocumentReference.type.coding.display",
"path": "DocumentReference.type.coding.display",
"mustSupport": true
}, {
"id": "DocumentReference.type.coding.userSelected",
"path": "DocumentReference.type.coding.userSelected",
"mustSupport": true
}, {
"id": "DocumentReference.type.text",
"min": 1,
"path": "DocumentReference.type.text",
"mustSupport": true
}, {
"id": "DocumentReference.type.text.extension",
"min": 0,
"path": "DocumentReference.type.text.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "DocumentReference.type.text.extension:TypeTextTranslation",
"max": "1",
"min": 0,
"path": "DocumentReference.type.text.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/translation" ]
} ],
"sliceName": "TypeTextTranslation",
"mustSupport": true
}, {
"id": "DocumentReference.category",
"max": "10",
"path": "DocumentReference.category",
"binding": {
"strength": "extensible",
"valueSet": "http://telus.com/fhir/ValueSet/telus-documentreference-type-category"
},
"comment": "Conformance Rule: Populate category with the best, most precise LOINC code corresponding to each category code in the source system. Multiple categories may be specified in some cases. Example: A document could be categorized as both a Discharge Summary and a Post-Operative Report.\r\n\r\nUsage note: A category will typically pertain to the specialty, eg Chemotherapy, Cardiology. This could be a repetition of the type, if the type is not a combination code of type/specialty, eg diabetes prorgess note. The type could be \"progress note\", or \"diabetes progress note\". If the document is a template/custom form/observational template, the name of the template would be captured as \"text\", eg \"CDM diabetes visit\". \r\n\r\nUsage Rule: The POS must send a local code and the LOINC code.\r\n\r\nUsage Note: In future releases a full set of LOINC codes (including LOINC.Ontology codes) will be added to this value set. Implementers should expect that this value set will be provided outside of the specification. This will not be populated on messages that originate from sending systems on an earlier May 2016 version.",
"mustSupport": true
}, {
"id": "DocumentReference.category.coding",
"max": "5",
"path": "DocumentReference.category.coding",
"mustSupport": true
}, {
"id": "DocumentReference.category.coding.system",
"min": 1,
"path": "DocumentReference.category.coding.system",
"mustSupport": true
}, {
"id": "DocumentReference.category.coding.code",
"min": 1,
"path": "DocumentReference.category.coding.code",
"mustSupport": true
}, {
"id": "DocumentReference.category.coding.display",
"path": "DocumentReference.category.coding.display",
"mustSupport": true
}, {
"id": "DocumentReference.category.coding.userSelected",
"path": "DocumentReference.category.coding.userSelected",
"mustSupport": true
}, {
"id": "DocumentReference.category.text",
"min": 1,
"path": "DocumentReference.category.text",
"mustSupport": true
}, {
"id": "DocumentReference.category.text.extension",
"min": 0,
"path": "DocumentReference.category.text.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "DocumentReference.category.text.extension:CategoryTextTranslation",
"max": "1",
"min": 0,
"path": "DocumentReference.category.text.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/translation" ]
} ],
"sliceName": "CategoryTextTranslation",
"mustSupport": true
}, {
"id": "DocumentReference.subject",
"min": 1,
"path": "DocumentReference.subject",
"mustSupport": true
}, {
"id": "DocumentReference.subject.reference",
"min": 1,
"path": "DocumentReference.subject.reference",
"mustSupport": true
}, {
"id": "DocumentReference.subject.display",
"path": "DocumentReference.subject.display",
"comment": "Usage Note: This should contain the name of the Patient, which can then be used in narrative where applicable\r\n\r\nThis is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"mustSupport": true
}, {
"id": "DocumentReference.date",
"path": "DocumentReference.date",
"comment": "Usage Note: This is the date of the clinical note.\r\n\r\nReferencing/indexing time is used for tracking, organizing versions and searching.",
"mustSupport": true
}, {
"id": "DocumentReference.author",
"path": "DocumentReference.author",
"mustSupport": true
}, {
"id": "DocumentReference.relatesTo",
"path": "DocumentReference.relatesTo",
"mustSupport": true
}, {
"id": "DocumentReference.description",
"path": "DocumentReference.description",
"comment": "Usage Note: This should be populated with the title, eg \"Dec 27, 2015, A: Gout, Left Foot\". This could be created from the Table of Contents in an EMR or a Summary from the Visit Tab. \r\n\r\nWhat the document is about, a terse summary of the document.",
"mustSupport": true
}, {
"id": "DocumentReference.content",
"max": "1",
"path": "DocumentReference.content",
"comment": "Conformance Rule: This is used to convey eServices discrete data bundles and/or attachments. If a discrete bundle is present, the related PDF must also be referenced below.\r\nUsage: Often used to capture clinical notes from the EMR that are pertinent to the Patient Chart data being sent",
"mustSupport": true
}, {
"id": "DocumentReference.content.attachment",
"path": "DocumentReference.content.attachment",
"comment": "Conformance Rule: When including an eServices bundle (DocumentReference.extension:RelatedBundle), there must be a PDF attachment relating to this for consuming applications who cannot process the discrete data in the bundle.\r\n\r\nWhen providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as \"Signed Procedure Consent\".",
"mustSupport": true
}, {
"id": "DocumentReference.content.attachment.contentType",
"min": 1,
"path": "DocumentReference.content.attachment.contentType",
"binding": {
"strength": "required",
"valueSet": "http://telus.com/fhir/ValueSet/telus-attachment-type"
},
"mustSupport": true
}, {
"id": "DocumentReference.content.attachment.language",
"path": "DocumentReference.content.attachment.language",
"mustSupport": true
}, {
"id": "DocumentReference.content.attachment.data",
"path": "DocumentReference.content.attachment.data",
"comment": "Usage Note: In most cases, data is expected to convey the clinical notes.\r\n\r\nThe base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.",
"mustSupport": true
}, {
"id": "DocumentReference.content.attachment.url",
"path": "DocumentReference.content.attachment.url",
"comment": "Usage: The EMR's may have a URL from an external source. eg - Repository to diagnostic images",
"mustSupport": true
}, {
"id": "DocumentReference.content.attachment.size",
"path": "DocumentReference.content.attachment.size",
"comment": "Usage: Size is useful if there is a URL as it indicates the size prior to downloading\r\n\r\nThe number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a URL reference.",
"mustSupport": true
}, {
"id": "DocumentReference.content.attachment.hash",
"path": "DocumentReference.content.attachment.hash",
"mustSupport": true
}, {
"id": "DocumentReference.content.attachment.title",
"path": "DocumentReference.content.attachment.title",
"comment": "Usage Note: This could be populated with a template name, or if passing on an external note, the title of the attachment may be useful.\r\n\r\nNote that FHIR strings SHALL NOT exceed 1MB in size",
"mustSupport": true
}, {
"id": "DocumentReference.content.attachment.creation",
"path": "DocumentReference.content.attachment.creation",
"mustSupport": true
}, {
"id": "DocumentReference.content.format",
"path": "DocumentReference.content.format",
"comment": "Usage Note: Intended to convey the set of template rules that this content adheres to. Particularly useful for CDA documents. eg Discharge summary following pattern A; \r\n\r\nNote that while IHE mostly issues URNs for format types, not all documents can be identified by a URI."
}, {
"id": "DocumentReference.context",
"path": "DocumentReference.context",
"mustSupport": true
}, {
"id": "DocumentReference.context.encounter",
"path": "DocumentReference.context.encounter",
"comment": "Usage: Encounter will be used to capture the diagnosis and other visit data\r\n\r\nReferences SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"mustSupport": true
}, {
"id": "DocumentReference.context.encounter.reference",
"path": "DocumentReference.context.encounter.reference",
"mustSupport": true
}, {
"id": "DocumentReference.context.encounter.display",
"path": "DocumentReference.context.encounter.display",
"mustSupport": true
}, {
"id": "DocumentReference.context.period",
"path": "DocumentReference.context.period",
"comment": "Usage: This will be populated with the date that is pertinent to the clinical note. eg the date of surgery that the note pertains to. This is distinct from the DocumentRefernece.date which captures the date that the note was authored. \r\n\r\nA Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).",
"mustSupport": true
}, {
"id": "DocumentReference.context.period.start",
"path": "DocumentReference.context.period.start",
"mustSupport": true
}, {
"id": "DocumentReference.context.period.end",
"min": 1,
"path": "DocumentReference.context.period.end",
"mustSupport": true
}, {
"id": "DocumentReference.context.sourcePatientInfo",
"min": 1,
"path": "DocumentReference.context.sourcePatientInfo",
"comment": "Usage Note: This must be populated unless it is not tied to a patient.\r\n\r\nReferences SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"mustSupport": true
}, {
"id": "DocumentReference.context.sourcePatientInfo.reference",
"min": 1,
"path": "DocumentReference.context.sourcePatientInfo.reference",
"mustSupport": true
}, {
"id": "DocumentReference.context.sourcePatientInfo.display",
"path": "DocumentReference.context.sourcePatientInfo.display",
"comment": "Usage Note: This should contain the name of the Patient, which can then be used in narrative where applicable\r\n\r\nThis is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"mustSupport": true
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DocumentReference"
}