Interweave Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
Resource Profile: CareConnectDocumentReference1
| Official URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-DocumentReference-1 | Version: 0.1.0 | |||
| Draft as of 2019-08-07 | Computable Name: CareConnect-DocumentReference-1 | |||
Copyright/Legal: Copyright © 2019 HL7 UK Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html |
||||
The DocumentReference resource is used to describe a document that is made available to a healthcare system.
CURATED BY INTEROPen see: http://www.interopen.org/careconnect-curation-methodology/ on the 5th July 2019.
Usage:
- Derived from this Resource Profile: InterweaveDocumentReference
- Refer to this Resource Profile: CareConnect-DocumentReference-1, InterweaveDocumentReference and InterweaveSocialCareAssessment
- Examples for this Resource Profile: DocumentReference/InterweaveDocumentReferenceExample
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DocumentReference
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  DocumentReference | 0..* | DocumentReference | A reference to a document | |
  masterIdentifier | ||||
  system | 1..1 | uri | The namespace for the identifier value | |
| value | 1..1 | string | The value that is unique | |
  assigner | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | |
| identifier | ||||
| system | 1..1 | uri | The namespace for the identifier value | |
| value | 1..1 | string | The value that is unique | |
| assigner | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | |
| type | 1..1 | CodeableConcept | Type of document Binding: Care Connect Document Type (preferred): SNOMED CT UK document type | |
 coding | ||||
 system | 1..1 | uri | Identity of the terminology system | |
| version | 0..0 | |||
| code | 1..1 | code | Symbol in syntax defined by the system | |
| display | 1..1 | string | Representation defined by the system | |
| subject | 0..1 | Reference(Group | Device | CareConnect-Practitioner-1 | CareConnectPatient1) | Who/what is the subject of the document | |
| created | 0..1 | dateTime | Document creation time | |
| author | 0..* | Reference(Device | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1 | CareConnectPatient1 | CareConnect-Organization-1) | Who and/or what authored the document | |
| authenticator | 0..1 | Reference(CareConnect-Practitioner-1 | CareConnect-Organization-1) | Who/what authenticated the document | |
| custodian | 0..1 | Reference(CareConnect-Organization-1) | Organization which maintains the document | |
| relatesTo | ||||
| target | 1..1 | Reference(CareConnect-DocumentReference-1) | Target of the relationship | |
| context | ||||
| encounter | 0..1 | Reference(CareConnect-Encounter-1) | Context of the document content | |
| practiceSetting | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: Care Connect Care Setting Type (preferred): Care setting type of the document | |
| sourcePatientInfo | 0..1 | Reference(CareConnectPatient1) | Patient demographics from source | |
| related | ||||
| identifier | ||||
| assigner | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet |
| DocumentReference.type | preferred | Care Connect Document Type |
| DocumentReference.context.practiceSetting | preferred | Care Connect Care Setting Type |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DocumentReference | 0..* | DocumentReference | A reference to a document | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. |
 type | Σ | 1..1 | CodeableConcept | Type of document Binding: Care Connect Document Type (preferred): SNOMED CT UK document type |
| subject | Σ | 0..1 | Reference(Group | Device | CareConnect-Practitioner-1 | CareConnectPatient1) | Who/what is the subject of the document |
| created | Σ | 0..1 | dateTime | Document creation time |
| indexed | Σ | 1..1 | instant | When this document reference was created |
| author | Σ | 0..* | Reference(Device | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1 | CareConnectPatient1 | CareConnect-Organization-1) | Who and/or what authored the document |
| authenticator | Σ | 0..1 | Reference(CareConnect-Practitioner-1 | CareConnect-Organization-1) | Who/what authenticated the document |
| custodian | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization which maintains the document |
| relatesTo | ?!Σ | 0..* | BackboneElement | Relationships to other documents |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| code | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. |
| target | Σ | 1..1 | Reference(CareConnect-DocumentReference-1) | Target of the relationship |
| content | Σ | 1..* | BackboneElement | Document referenced |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| attachment | Σ | 1..1 | Attachment | Where to access the document |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| DocumentReference.status | required | DocumentReferenceStatus |
| DocumentReference.type | preferred | Care Connect Document Type |
| DocumentReference.relatesTo.code | required | DocumentRelationshipType |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-1 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | DocumentReference | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
| dom-4 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| DocumentReference | 0..* | DocumentReference | A reference to a document | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| masterIdentifier | Σ | 0..1 | Identifier | Master Version Specific Identifier | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | ||||
| identifier | Σ | 0..* | Identifier | Other identifiers for the document | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | ||||
| status | ?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
| docStatus | Σ | 0..1 | code | preliminary | final | appended | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | ||||
| type | Σ | 1..1 | CodeableConcept | Type of document Binding: Care Connect Document Type (preferred): SNOMED CT UK document type | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 1..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| class | Σ | 0..1 | CodeableConcept | Categorization of document Binding: Document Class Value Set (example): High-level kind of a clinical document at a macro level. | ||||
| subject | Σ | 0..1 | Reference(Group | Device | CareConnect-Practitioner-1 | CareConnectPatient1) | Who/what is the subject of the document | ||||
| created | Σ | 0..1 | dateTime | Document creation time | ||||
| indexed | Σ | 1..1 | instant | When this document reference was created | ||||
| author | Σ | 0..* | Reference(Device | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1 | CareConnectPatient1 | CareConnect-Organization-1) | Who and/or what authored the document | ||||
| authenticator | Σ | 0..1 | Reference(CareConnect-Practitioner-1 | CareConnect-Organization-1) | Who/what authenticated the document | ||||
| custodian | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization which maintains the document | ||||
| relatesTo | ?!Σ | 0..* | BackboneElement | Relationships to other documents | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| code | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
| target | Σ | 1..1 | Reference(CareConnect-DocumentReference-1) | Target of the relationship | ||||
| description | Σ | 0..1 | string | Human-readable description (title) | ||||
| securityLabel | Σ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| content | Σ | 1..* | BackboneElement | Document referenced | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| attachment | Σ | 1..1 | Attachment | Where to access the document | ||||
| format | Σ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReference Format Code Set (preferred): Document Format Codes. | ||||
| context | Σ | 0..1 | BackboneElement | Clinical context of document | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| encounter | Σ | 0..1 | Reference(CareConnect-Encounter-1) | Context of the document content | ||||
| event | Σ | 0..* | CodeableConcept | Main clinical acts documented Binding: ActCode (example): This list of codes represents the main clinical acts being documented. | ||||
| period | Σ | 0..1 | Period | Time of service that is being documented | ||||
| facilityType | Σ | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: Facility Type Code Value Set (example): XDS Facility Type. | ||||
| practiceSetting | Σ | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: Care Connect Care Setting Type (preferred): Care setting type of the document | ||||
| sourcePatientInfo | Σ | 0..1 | Reference(CareConnectPatient1) | Patient demographics from source | ||||
| related | Σ | 0..* | BackboneElement | Related identifiers or resources | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..1 | Identifier | Identifier of related objects or events | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | ||||
| ref | Σ | 0..1 | Reference(Resource) | Related Resource | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| DocumentReference.language | extensible | Common Languages
| ||||
| DocumentReference.masterIdentifier.use | required | IdentifierUse | ||||
| DocumentReference.masterIdentifier.type | extensible | Identifier Type Codes | ||||
| DocumentReference.identifier.use | required | IdentifierUse | ||||
| DocumentReference.identifier.type | extensible | Identifier Type Codes | ||||
| DocumentReference.status | required | DocumentReferenceStatus | ||||
| DocumentReference.docStatus | required | CompositionStatus | ||||
| DocumentReference.type | preferred | Care Connect Document Type | ||||
| DocumentReference.class | example | Document Class Value Set | ||||
| DocumentReference.relatesTo.code | required | DocumentRelationshipType | ||||
| DocumentReference.securityLabel | extensible | All Security Labels | ||||
| DocumentReference.content.format | preferred | DocumentReference Format Code Set | ||||
| DocumentReference.context.event | example | v3 Code System ActCode | ||||
| DocumentReference.context.facilityType | example | Facility Type Code Value Set | ||||
| DocumentReference.context.practiceSetting | preferred | Care Connect Care Setting Type | ||||
| DocumentReference.context.related.identifier.use | required | IdentifierUse | ||||
| DocumentReference.context.related.identifier.type | extensible | Identifier Type Codes |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |
This structure is derived from DocumentReference
Summary
Mandatory: 0 element (7 nested mandatory elements)
Prohibited: 1 element
Structures
This structure refers to these other structures:
- CareConnect-Organization-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1)
- CareConnect-Practitioner-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1)
- CareConnectPatient1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1)
- CareConnect-RelatedPerson-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-RelatedPerson-1)
- CareConnect-DocumentReference-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-DocumentReference-1)
- CareConnect-Encounter-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1)
Differential View
This structure is derived from DocumentReference
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DocumentReference | 0..* | DocumentReference | A reference to a document | |
| masterIdentifier | ||||
| system | 1..1 | uri | The namespace for the identifier value | |
| value | 1..1 | string | The value that is unique | |
| assigner | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | |
| identifier | ||||
| system | 1..1 | uri | The namespace for the identifier value | |
| value | 1..1 | string | The value that is unique | |
| assigner | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | |
| type | 1..1 | CodeableConcept | Type of document Binding: Care Connect Document Type (preferred): SNOMED CT UK document type | |
| coding | ||||
| system | 1..1 | uri | Identity of the terminology system | |
| version | 0..0 | |||
| code | 1..1 | code | Symbol in syntax defined by the system | |
| display | 1..1 | string | Representation defined by the system | |
| subject | 0..1 | Reference(Group | Device | CareConnect-Practitioner-1 | CareConnectPatient1) | Who/what is the subject of the document | |
| created | 0..1 | dateTime | Document creation time | |
| author | 0..* | Reference(Device | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1 | CareConnectPatient1 | CareConnect-Organization-1) | Who and/or what authored the document | |
| authenticator | 0..1 | Reference(CareConnect-Practitioner-1 | CareConnect-Organization-1) | Who/what authenticated the document | |
| custodian | 0..1 | Reference(CareConnect-Organization-1) | Organization which maintains the document | |
| relatesTo | ||||
| target | 1..1 | Reference(CareConnect-DocumentReference-1) | Target of the relationship | |
| context | ||||
| encounter | 0..1 | Reference(CareConnect-Encounter-1) | Context of the document content | |
| practiceSetting | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: Care Connect Care Setting Type (preferred): Care setting type of the document | |
| sourcePatientInfo | 0..1 | Reference(CareConnectPatient1) | Patient demographics from source | |
| related | ||||
| identifier | ||||
| assigner | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet |
| DocumentReference.type | preferred | Care Connect Document Type |
| DocumentReference.context.practiceSetting | preferred | Care Connect Care Setting Type |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DocumentReference | 0..* | DocumentReference | A reference to a document | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. |
| type | Σ | 1..1 | CodeableConcept | Type of document Binding: Care Connect Document Type (preferred): SNOMED CT UK document type |
| subject | Σ | 0..1 | Reference(Group | Device | CareConnect-Practitioner-1 | CareConnectPatient1) | Who/what is the subject of the document |
| created | Σ | 0..1 | dateTime | Document creation time |
| indexed | Σ | 1..1 | instant | When this document reference was created |
| author | Σ | 0..* | Reference(Device | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1 | CareConnectPatient1 | CareConnect-Organization-1) | Who and/or what authored the document |
| authenticator | Σ | 0..1 | Reference(CareConnect-Practitioner-1 | CareConnect-Organization-1) | Who/what authenticated the document |
| custodian | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization which maintains the document |
| relatesTo | ?!Σ | 0..* | BackboneElement | Relationships to other documents |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| code | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. |
| target | Σ | 1..1 | Reference(CareConnect-DocumentReference-1) | Target of the relationship |
| content | Σ | 1..* | BackboneElement | Document referenced |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| attachment | Σ | 1..1 | Attachment | Where to access the document |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| DocumentReference.status | required | DocumentReferenceStatus |
| DocumentReference.type | preferred | Care Connect Document Type |
| DocumentReference.relatesTo.code | required | DocumentRelationshipType |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-1 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | DocumentReference | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
| dom-4 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| DocumentReference | 0..* | DocumentReference | A reference to a document | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| masterIdentifier | Σ | 0..1 | Identifier | Master Version Specific Identifier | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | ||||
| identifier | Σ | 0..* | Identifier | Other identifiers for the document | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | ||||
| status | ?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
| docStatus | Σ | 0..1 | code | preliminary | final | appended | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | ||||
| type | Σ | 1..1 | CodeableConcept | Type of document Binding: Care Connect Document Type (preferred): SNOMED CT UK document type | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 1..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| class | Σ | 0..1 | CodeableConcept | Categorization of document Binding: Document Class Value Set (example): High-level kind of a clinical document at a macro level. | ||||
| subject | Σ | 0..1 | Reference(Group | Device | CareConnect-Practitioner-1 | CareConnectPatient1) | Who/what is the subject of the document | ||||
| created | Σ | 0..1 | dateTime | Document creation time | ||||
| indexed | Σ | 1..1 | instant | When this document reference was created | ||||
| author | Σ | 0..* | Reference(Device | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1 | CareConnectPatient1 | CareConnect-Organization-1) | Who and/or what authored the document | ||||
| authenticator | Σ | 0..1 | Reference(CareConnect-Practitioner-1 | CareConnect-Organization-1) | Who/what authenticated the document | ||||
| custodian | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization which maintains the document | ||||
| relatesTo | ?!Σ | 0..* | BackboneElement | Relationships to other documents | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| code | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
| target | Σ | 1..1 | Reference(CareConnect-DocumentReference-1) | Target of the relationship | ||||
| description | Σ | 0..1 | string | Human-readable description (title) | ||||
| securityLabel | Σ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| content | Σ | 1..* | BackboneElement | Document referenced | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| attachment | Σ | 1..1 | Attachment | Where to access the document | ||||
| format | Σ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReference Format Code Set (preferred): Document Format Codes. | ||||
| context | Σ | 0..1 | BackboneElement | Clinical context of document | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| encounter | Σ | 0..1 | Reference(CareConnect-Encounter-1) | Context of the document content | ||||
| event | Σ | 0..* | CodeableConcept | Main clinical acts documented Binding: ActCode (example): This list of codes represents the main clinical acts being documented. | ||||
| period | Σ | 0..1 | Period | Time of service that is being documented | ||||
| facilityType | Σ | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: Facility Type Code Value Set (example): XDS Facility Type. | ||||
| practiceSetting | Σ | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: Care Connect Care Setting Type (preferred): Care setting type of the document | ||||
| sourcePatientInfo | Σ | 0..1 | Reference(CareConnectPatient1) | Patient demographics from source | ||||
| related | Σ | 0..* | BackboneElement | Related identifiers or resources | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..1 | Identifier | Identifier of related objects or events | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | ||||
| ref | Σ | 0..1 | Reference(Resource) | Related Resource | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| DocumentReference.language | extensible | Common Languages
| ||||
| DocumentReference.masterIdentifier.use | required | IdentifierUse | ||||
| DocumentReference.masterIdentifier.type | extensible | Identifier Type Codes | ||||
| DocumentReference.identifier.use | required | IdentifierUse | ||||
| DocumentReference.identifier.type | extensible | Identifier Type Codes | ||||
| DocumentReference.status | required | DocumentReferenceStatus | ||||
| DocumentReference.docStatus | required | CompositionStatus | ||||
| DocumentReference.type | preferred | Care Connect Document Type | ||||
| DocumentReference.class | example | Document Class Value Set | ||||
| DocumentReference.relatesTo.code | required | DocumentRelationshipType | ||||
| DocumentReference.securityLabel | extensible | All Security Labels | ||||
| DocumentReference.content.format | preferred | DocumentReference Format Code Set | ||||
| DocumentReference.context.event | example | v3 Code System ActCode | ||||
| DocumentReference.context.facilityType | example | Facility Type Code Value Set | ||||
| DocumentReference.context.practiceSetting | preferred | Care Connect Care Setting Type | ||||
| DocumentReference.context.related.identifier.use | required | IdentifierUse | ||||
| DocumentReference.context.related.identifier.type | extensible | Identifier Type Codes |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |
This structure is derived from DocumentReference
Summary
Mandatory: 0 element (7 nested mandatory elements)
Prohibited: 1 element
Structures
This structure refers to these other structures:
- CareConnect-Organization-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1)
- CareConnect-Practitioner-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1)
- CareConnectPatient1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1)
- CareConnect-RelatedPerson-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-RelatedPerson-1)
- CareConnect-DocumentReference-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-DocumentReference-1)
- CareConnect-Encounter-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1)
Other representations of profile: CSV, Excel, Schematron