1.0.0 - ci-build
1.0.0 - ci-build
HelseAPI - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://hl7.no/fhir/StructureDefinition/no-helseapi-DocumentReference | Version: 1.0.0 | |||
| Draft as of 2024-02-09 | Computable Name: NoHelseAPIDocumentReference | |||
Usage:
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 | |
  identifier | S | 0..* | Identifier | Other identifiers for the document |
| type | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: NO HelseAPI Document Reference Type (required) | |
| category | S | 1..* | CodeableConcept | Categorization of document Binding: NO HelseAPI Document Reference Category (extensible) |
| subject | 1..1 | Reference(Patient | Practitioner | Group | Device) | Who/what is the subject of the document | |
| date | S | 0..1 | instant | When this document reference was created |
| author | S | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document |
| custodian | S | 0..1 | Reference(Organization) | Organization which maintains the document |
 content | ||||
  attachment | ||||
 contentType | 1..1 | code | Mime type of the content, with charset etc. | |
| data | S | 0..1 | base64Binary | Data inline, base64ed |
 url | S | 0..1 | url | Uri where the data can be found |
| context | ||||
| encounter | S | 0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content |
| period | S | 0..1 | Period | Time of service that is being documented |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| DocumentReference.type | required | NOHelseAPIDocumentReferenceTypehttp://hl7.no/fhir/ValueSet/no-helseapi-documentreference-typefrom this IG | |
| DocumentReference.category | extensible | NOHelseAPIDocumentReferenceCategory (a valid code from NO HelseAPI DocumentReferences Category Codes)http://hl7.no/fhir/ValueSet/no-helseapi-documentreference-categoryfrom this IG |
| 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 |
 identifier | SΣ | 0..* | Identifier | Other identifiers for the document |
| status | ?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. |
| type | Σ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: NO HelseAPI Document Reference Type (required) |
| category | SΣ | 1..* | CodeableConcept | Categorization of document Binding: NO HelseAPI Document Reference Category (extensible) |
 subject | Σ | 1..1 | Reference(Patient | Practitioner | Group | Device) | Who/what is the subject of the document |
| date | SΣ | 0..1 | instant | When this document reference was created |
| author | SΣ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document |
| custodian | S | 0..1 | Reference(Organization) | Organization which maintains the document |
| content | Σ | 1..* | BackboneElement | Document referenced |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| attachment | Σ | 1..1 | Attachment | Where to access the document |
| contentType | Σ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png |
| data | S | 0..1 | base64Binary | Data inline, base64ed |
| url | SΣ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png |
| context | Σ | 0..1 | BackboneElement | Clinical context of document |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| encounter | S | 0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content |
| period | SΣ | 0..1 | Period | Time of service that is being documented |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1from the FHIR Standard | |
| DocumentReference.type | required | NOHelseAPIDocumentReferenceTypehttp://hl7.no/fhir/ValueSet/no-helseapi-documentreference-typefrom this IG | |
| DocumentReference.category | extensible | NOHelseAPIDocumentReferenceCategory (a valid code from NO HelseAPI DocumentReferences Category Codes)http://hl7.no/fhir/ValueSet/no-helseapi-documentreference-categoryfrom this IG | |
| DocumentReference.content.attachment.contentType | required | Mime Types (a valid code from urn:ietf:bcp:13)http://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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 or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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() | |
| dom-5 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | DocumentReference | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| 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: CommonLanguages (preferred): 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 | ||||
| identifier | SΣ | 0..* | Identifier | Other identifiers for the document | ||||
| status | ?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
| docStatus | Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | ||||
| type | Σ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: NO HelseAPI Document Reference Type (required) | ||||
| category | SΣ | 1..* | CodeableConcept | Categorization of document Binding: NO HelseAPI Document Reference Category (extensible) | ||||
| subject | Σ | 1..1 | Reference(Patient | Practitioner | Group | Device) | Who/what is the subject of the document | ||||
| date | SΣ | 0..1 | instant | When this document reference was created | ||||
| author | SΣ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document | ||||
| authenticator | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | |||||
| custodian | S | 0..1 | Reference(Organization) | Organization which maintains the document | ||||
| relatesTo | Σ | 0..* | BackboneElement | Relationships to other documents | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
| target | Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
| description | Σ | 0..1 | string | Human-readable description | ||||
| 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 | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| attachment | Σ | 1..1 | Attachment | Where to access the document | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType | Σ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
| data | S | 0..1 | base64Binary | Data inline, base64ed | ||||
| url | SΣ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
| size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
| hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
| title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
| creation | Σ | 0..1 | dateTime | Date attachment was first created | ||||
| format | Σ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. | ||||
| context | Σ | 0..1 | BackboneElement | Clinical context of document | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| encounter | S | 0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content | ||||
| event | 0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
| period | SΣ | 0..1 | Period | Time of service that is being documented | ||||
| facilityType | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||
| practiceSetting | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty). | |||||
| sourcePatientInfo | 0..1 | Reference(Patient) | Patient demographics from source | |||||
| related | 0..* | Reference(Resource) | Related identifiers or resources | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| DocumentReference.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1from the FHIR Standard | ||||
| DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1from the FHIR Standard | ||||
| DocumentReference.type | required | NOHelseAPIDocumentReferenceTypehttp://hl7.no/fhir/ValueSet/no-helseapi-documentreference-typefrom this IG | ||||
| DocumentReference.category | extensible | NOHelseAPIDocumentReferenceCategory (a valid code from NO HelseAPI DocumentReferences Category Codes)http://hl7.no/fhir/ValueSet/no-helseapi-documentreference-categoryfrom this IG | ||||
| DocumentReference.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard | ||||
| DocumentReference.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| DocumentReference.content.attachment.contentType | required | Mime Types (a valid code from urn:ietf:bcp:13)http://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard | ||||
| DocumentReference.content.attachment.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| DocumentReference.content.format | preferred | DocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem)http://hl7.org/fhir/ValueSet/formatcodesfrom the FHIR Standard | ||||
| DocumentReference.context.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
| DocumentReference.context.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodesfrom the FHIR Standard | ||||
| DocumentReference.context.practiceSetting | example | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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 or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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() | |
| dom-5 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | DocumentReference | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from DocumentReference
Differential View
This structure is derived from DocumentReference
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DocumentReference | 0..* | DocumentReference | A reference to a document | |
| identifier | S | 0..* | Identifier | Other identifiers for the document |
| type | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: NO HelseAPI Document Reference Type (required) | |
| category | S | 1..* | CodeableConcept | Categorization of document Binding: NO HelseAPI Document Reference Category (extensible) |
| subject | 1..1 | Reference(Patient | Practitioner | Group | Device) | Who/what is the subject of the document | |
| date | S | 0..1 | instant | When this document reference was created |
| author | S | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document |
| custodian | S | 0..1 | Reference(Organization) | Organization which maintains the document |
| content | ||||
| attachment | ||||
| contentType | 1..1 | code | Mime type of the content, with charset etc. | |
| data | S | 0..1 | base64Binary | Data inline, base64ed |
| url | S | 0..1 | url | Uri where the data can be found |
| context | ||||
| encounter | S | 0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content |
| period | S | 0..1 | Period | Time of service that is being documented |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| DocumentReference.type | required | NOHelseAPIDocumentReferenceTypehttp://hl7.no/fhir/ValueSet/no-helseapi-documentreference-typefrom this IG | |
| DocumentReference.category | extensible | NOHelseAPIDocumentReferenceCategory (a valid code from NO HelseAPI DocumentReferences Category Codes)http://hl7.no/fhir/ValueSet/no-helseapi-documentreference-categoryfrom this IG |
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 |
| identifier | SΣ | 0..* | Identifier | Other identifiers for the document |
| status | ?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. |
| type | Σ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: NO HelseAPI Document Reference Type (required) |
| category | SΣ | 1..* | CodeableConcept | Categorization of document Binding: NO HelseAPI Document Reference Category (extensible) |
| subject | Σ | 1..1 | Reference(Patient | Practitioner | Group | Device) | Who/what is the subject of the document |
| date | SΣ | 0..1 | instant | When this document reference was created |
| author | SΣ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document |
| custodian | S | 0..1 | Reference(Organization) | Organization which maintains the document |
| content | Σ | 1..* | BackboneElement | Document referenced |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| attachment | Σ | 1..1 | Attachment | Where to access the document |
| contentType | Σ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png |
| data | S | 0..1 | base64Binary | Data inline, base64ed |
| url | SΣ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png |
| context | Σ | 0..1 | BackboneElement | Clinical context of document |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| encounter | S | 0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content |
| period | SΣ | 0..1 | Period | Time of service that is being documented |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1from the FHIR Standard | |
| DocumentReference.type | required | NOHelseAPIDocumentReferenceTypehttp://hl7.no/fhir/ValueSet/no-helseapi-documentreference-typefrom this IG | |
| DocumentReference.category | extensible | NOHelseAPIDocumentReferenceCategory (a valid code from NO HelseAPI DocumentReferences Category Codes)http://hl7.no/fhir/ValueSet/no-helseapi-documentreference-categoryfrom this IG | |
| DocumentReference.content.attachment.contentType | required | Mime Types (a valid code from urn:ietf:bcp:13)http://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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 or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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() | |
| dom-5 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | DocumentReference | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
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: CommonLanguages (preferred): 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 | ||||
| identifier | SΣ | 0..* | Identifier | Other identifiers for the document | ||||
| status | ?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
| docStatus | Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | ||||
| type | Σ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: NO HelseAPI Document Reference Type (required) | ||||
| category | SΣ | 1..* | CodeableConcept | Categorization of document Binding: NO HelseAPI Document Reference Category (extensible) | ||||
| subject | Σ | 1..1 | Reference(Patient | Practitioner | Group | Device) | Who/what is the subject of the document | ||||
| date | SΣ | 0..1 | instant | When this document reference was created | ||||
| author | SΣ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document | ||||
| authenticator | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | |||||
| custodian | S | 0..1 | Reference(Organization) | Organization which maintains the document | ||||
| relatesTo | Σ | 0..* | BackboneElement | Relationships to other documents | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
| target | Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
| description | Σ | 0..1 | string | Human-readable description | ||||
| 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 | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| attachment | Σ | 1..1 | Attachment | Where to access the document | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType | Σ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
| data | S | 0..1 | base64Binary | Data inline, base64ed | ||||
| url | SΣ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
| size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
| hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
| title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
| creation | Σ | 0..1 | dateTime | Date attachment was first created | ||||
| format | Σ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. | ||||
| context | Σ | 0..1 | BackboneElement | Clinical context of document | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| encounter | S | 0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content | ||||
| event | 0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
| period | SΣ | 0..1 | Period | Time of service that is being documented | ||||
| facilityType | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||
| practiceSetting | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty). | |||||
| sourcePatientInfo | 0..1 | Reference(Patient) | Patient demographics from source | |||||
| related | 0..* | Reference(Resource) | Related identifiers or resources | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| DocumentReference.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1from the FHIR Standard | ||||
| DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1from the FHIR Standard | ||||
| DocumentReference.type | required | NOHelseAPIDocumentReferenceTypehttp://hl7.no/fhir/ValueSet/no-helseapi-documentreference-typefrom this IG | ||||
| DocumentReference.category | extensible | NOHelseAPIDocumentReferenceCategory (a valid code from NO HelseAPI DocumentReferences Category Codes)http://hl7.no/fhir/ValueSet/no-helseapi-documentreference-categoryfrom this IG | ||||
| DocumentReference.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard | ||||
| DocumentReference.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| DocumentReference.content.attachment.contentType | required | Mime Types (a valid code from urn:ietf:bcp:13)http://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard | ||||
| DocumentReference.content.attachment.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| DocumentReference.content.format | preferred | DocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem)http://hl7.org/fhir/ValueSet/formatcodesfrom the FHIR Standard | ||||
| DocumentReference.context.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
| DocumentReference.context.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodesfrom the FHIR Standard | ||||
| DocumentReference.context.practiceSetting | example | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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 or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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() | |
| dom-5 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | DocumentReference | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from DocumentReference
Other representations of profile: CSV, Excel, Schematron