{ "resourceType": "StructureDefinition", "id": "us-core-documentreference", "text": { "status": "generated", "div": "
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" DocumentReference 0..*
\".\"\".\"\".\" identifier S0..*Identifier
\".\"\".\"\".\" status S1..1codeBinding: DocumentReferenceStatus (required)
\".\"\".\"\".\" type S1..1CodeableConceptBinding: US Core DocumentReference Type (required)
Min Binding: US Core Clinical Note Type
\".\"\".\"\".\" category S1..*CodeableConceptBinding: US Core DocumentReference Category (extensible)
\".\"\".\"\".\" subject S1..1Reference(US Core Patient Profile)
\".\"\".\"\".\" date S0..1instant
\".\"\".\"\".\" author S0..*Reference(US Core Practitioner Profile | PractitionerRole | US Core Organization Profile | Device | US Core Patient Profile | RelatedPerson)
\".\"\".\"\".\" custodian S0..1Reference(US Core Organization Profile)
\".\"\".\"\".\" content S1..1BackboneElement
\".\"\".\"\".\"\".\" attachment SI1..1Attachmentus-core-6: DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present.
\".\"\".\"\".\"\".\"\".\" contentType S1..1code
\".\"\".\"\".\"\".\"\".\" data SI0..1base64Binary
\".\"\".\"\".\"\".\"\".\" url SI0..1url
\".\"\".\"\".\"\".\" format S0..1CodingBinding: DocumentReferenceFormatCodeSet (extensible)
\".\"\".\"\".\" context S0..1BackboneElement
\".\"\".\"\".\"\".\" encounter S0..1Reference(US Core Encounter Profile)
\".\"\".\"\".\"\".\" period S0..1Period

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference", "version": "3.1.0", "name": "USCoreDocumentReferenceProfile", "title": "US Core DocumentReference Profile", "status": "active", "experimental": false, "date": "2019-08-10T14:00:00+00:00", "publisher": "HL7 US Realm Steering Committee", "contact": [ { "telecom": [ { "system": "url", "value": "http://www.healthit.gov" } ] } ], "description": "The document reference profile used in US Core.", "jurisdiction": [ { "coding": [ { "system": "urn:iso:std:iso:3166", "code": "US", "display": "United States of America" } ] } ], "fhirVersion": "4.0.1", "mapping": [ { "identity": "workflow", "uri": "http://hl7.org/fhir/workflow", "name": "Workflow Pattern" }, { "identity": "fhircomposition", "uri": "http://hl7.org/fhir/composition", "name": "FHIR Composition" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "cda", "uri": "http://hl7.org/v3/cda", "name": "CDA (R2)" }, { "identity": "w5", "uri": "http://hl7.org/fhir/fivews", "name": "FiveWs Pattern Mapping" }, { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "xds", "uri": "http://ihe.net/xds", "name": "XDS metadata equivalent" } ], "kind": "resource", "abstract": false, "type": "DocumentReference", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DocumentReference", "derivation": "constraint", "snapshot": {}, "differential": { "element": [ { "id": "DocumentReference", "path": "DocumentReference", "definition": "This is a basic constraint on DocumentRefernce for use in the US Core IG.", "mustSupport": false }, { "id": "DocumentReference.identifier", "path": "DocumentReference.identifier", "min": 0, "max": "*", "mustSupport": true }, { "id": "DocumentReference.status", "path": "DocumentReference.status", "min": 1, "max": "1", "mustSupport": true, "binding": { "strength": "required", "valueSetUnknownType_StructureDefinition.differential.element[2].binding.valueSet": "http://hl7.org/fhir/ValueSet/document-reference-status" } }, { "id": "DocumentReference.type", "path": "DocumentReference.type", "min": 1, "max": "1", "mustSupport": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-minValueSet", "valueCanonical": "http://hl7.org/fhir/us/core/ValueSet/us-core-clinical-note-type" } ], "strength": "required", "description": "All LOINC values whose SCALE is DOC in the LOINC database and the HL7 v3 Code System NullFlavor concept 'unknown'", "valueSetUnknownType_StructureDefinition.differential.element[3].binding.valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-type" } }, { "id": "DocumentReference.category", "path": "DocumentReference.category", "min": 1, "max": "*", "mustSupport": true, "binding": { "strength": "extensible", "description": "The US Core DocumentReferences Type Value Set is a 'starter set' of categories supported for fetching and storing clinical notes.", "valueSetUnknownType_StructureDefinition.differential.element[4].binding.valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-category" } }, { "id": "DocumentReference.subject", "path": "DocumentReference.subject", "min": 1, "max": "1", "type": [ { "targetProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient" ], "code": "Reference" } ], "mustSupport": true }, { "id": "DocumentReference.date", "path": "DocumentReference.date", "min": 0, "max": "1", "mustSupport": true }, { "id": "DocumentReference.author", "path": "DocumentReference.author", "min": 0, "max": "*", "type": [ { "targetProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ], "code": "Reference" } ], "mustSupport": true }, { "id": "DocumentReference.custodian", "path": "DocumentReference.custodian", "type": [ { "targetProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization" ], "code": "Reference" } ], "mustSupport": true }, { "id": "DocumentReference.content", "path": "DocumentReference.content", "min": 1, "max": "1", "mustSupport": true }, { "id": "DocumentReference.content.attachment", "path": "DocumentReference.content.attachment", "min": 1, "max": "1", "constraint": [ { "key": "us-core-6", "severity": "error", "human": "DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present.", "expression": "url.exists() or data.exists()", "xpath": "f:url or f:content" } ], "mustSupport": true }, { "id": "DocumentReference.content.attachment.contentType", "path": "DocumentReference.content.attachment.contentType", "min": 1, "max": "1", "mustSupport": true }, { "id": "DocumentReference.content.attachment.data", "path": "DocumentReference.content.attachment.data", "min": 0, "max": "1", "condition": [ "us-core-6" ], "mustSupport": true }, { "id": "DocumentReference.content.attachment.url", "path": "DocumentReference.content.attachment.url", "min": 0, "max": "1", "condition": [ "us-core-6" ], "mustSupport": true }, { "id": "DocumentReference.content.format", "path": "DocumentReference.content.format", "min": 0, "max": "1", "mustSupport": true, "binding": { "strength": "extensible", "valueSetUnknownType_StructureDefinition.differential.element[14].binding.valueSet": "http://hl7.org/fhir/ValueSet/formatcodes" } }, { "id": "DocumentReference.context", "path": "DocumentReference.context", "min": 0, "max": "1", "mustSupport": true }, { "id": "DocumentReference.context.encounter", "path": "DocumentReference.context.encounter", "min": 0, "max": "1", "type": [ { "targetProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter" ], "code": "Reference" } ], "mustSupport": true }, { "id": "DocumentReference.context.period", "path": "DocumentReference.context.period", "mustSupport": true } ] } }