Defining URL: | https://fhir.medirecords.com/StructureDefinition/mr-documentreference-prescription |
Version: | 1.4.1 |
Name: | MRDocumentReferencePrescription |
Title: | MR DocumentReference Prescription |
Status: | Active as of 2024-10-28 02:34:31+0000 |
Definition: | MediRecords DocumentReference profile for medication prescription document |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
https://fhir.medirecords.com/StructureDefinition/mr-documentreference-prescription
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MRDocumentReference
Summary
Mandatory: 4 elements
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
This structure is derived from MRDocumentReference
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentReference | 0..* | MRDocumentReference | A reference to a document | |
Slices for identifier | 0..* | Identifier | Other identifiers for the document Slice: Unordered, Open by pattern:type | |
identifier:identifierLPN | S | 0..1 | AULocalPrescriptionIdentifier | Local Prescription Identifier |
system | 1..1 | uri | MediRecords tenant ID prefixed with 'urn:uuid:' | |
value | 1..1 | string | MediRecords script number, e.g. 4010 | |
assigner | ||||
display | 1..1 | string | MediRecords tenant name | |
type | 1..1 | CodeableConcept | Prescription for medication | |
category | 1..1 | CodeableConcept | Prescription for medication Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 57833-6 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Prescription for medication | |
date | 1..1 | instant | Prescription date | |
author | S | 1..1 | Reference(MR Practitioner) | Author of prescription |
content | ||||
attachment | ||||
contentType | 1..1 | code | application/pdf Required Pattern: application/pdf | |
context | ||||
Slices for related | 0..* | Reference(Resource) | Related identifiers or resources Slice: Unordered, Open by type:$this | |
related:prescription | S | 0..1 | Reference(MedicationRequest) | Reference to related prescription MedicationRequest |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
DocumentReference | 0..* | MRDocumentReference | A reference to a document | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | S | 0..1 | MRMeta | Metadata about a resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | SΣC | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. inv-mr-meta-security-01: Medirecords supports only U, R security code | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
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 | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
recipient | 0..1 | Reference(MR Practitioner | MR Organisation | MR Patient | MR PractitionerRole) | MR DocumentReference Recipient Extension URL: https://fhir.medirecords.com/StructureDefinition/mr-document-ref-recipient-extn | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "https://fhir.medirecords.com/StructureDefinition/mr-document-ref-recipient-extn" | |||||
Slices for value[x] | 1..1 | Reference(MR Practitioner | MR Organisation | MR Patient | MR PractitionerRole) | Document recipient Slice: Unordered, Closed by type:$this | |||||
value[x]:valueReference | 1..1 | Reference(MR Practitioner | MR Organisation | MR Patient) | Document recipient | |||||
documentTitle | 0..1 | string | MR DocumentReference Title Extension URL: https://fhir.medirecords.com/StructureDefinition/mr-document-ref-title-extn | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
masterIdentifier | Σ | 0..1 | Identifier | Master Version Specific Identifier | ||||
Slices for identifier | Σ | 0..* | Identifier | Other identifiers for the document Slice: Unordered, Open by pattern:type | ||||
identifier:identifierLPN | S | 0..1 | AULocalPrescriptionIdentifier | Local Prescription Identifier | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Coded identifier type for local prescription 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. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: LPN | |||||
display | 0..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 | |||||
system | Σ | 1..1 | uri | MediRecords tenant ID prefixed with 'urn:uuid:' Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | MediRecords script number, e.g. 4010 Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 1..1 | Reference(Organization) | Organisation that assigned the prescription identifier | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 1..1 | string | MediRecords tenant name | ||||
status | ?!SΣC | 1..1 | code | Indicates if document is Active(current) or Inactive(entered-in-error) Binding: DocumentReferenceStatus (required): The status of the document reference. inv-mr-docref-in-status-01: MediRecords supports only current - 'This is the current reference for this document' or entered-in-error - 'This reference was created in error' | ||||
docStatus | SΣ | 0..1 | code | Indicates if the document is Unchecked/Draft (preliminary) or Checked/Final (final) or Amended (amended) or Cancelled/Rejected (entered-in-error) Binding: CompositionStatus (required): Status of the underlying document. | ||||
type | SΣ | 1..1 | CodeableConcept | Prescription for medication Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. | ||||
category | SΣ | 1..1 | CodeableConcept | Prescription for medication Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 57833-6 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Prescription for medication | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
subject | SΣ | 1..1 | Reference(MR Patient) | The patient who is the subject of the document | ||||
date | SΣ | 1..1 | instant | Prescription date | ||||
author | SΣ | 1..1 | Reference(MR Practitioner) | Author of prescription | ||||
authenticator | 0..1 | Reference(MR Practitioner) | The user from the practice who checked the document on upload | |||||
custodian | S | 1..1 | Reference(MR Organisation) | 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 | SΣ | 1..1 | code | application/pdf Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/pdf | ||||
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 | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
size | SΣ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
title | SΣ | 0..1 | string | The file name of the attachment 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..1 | Reference(MR Encounter | MR Encounter Admission) | 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 | Σ | 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 | |||||
Slices for related | 0..* | Reference(Resource) | Related identifiers or resources Slice: Unordered, Open by type:$this | |||||
related:prescription | S | 0..1 | Reference(MedicationRequest) | Reference to related prescription MedicationRequest | ||||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentReference | 0..* | MRDocumentReference | A reference to a document | |
meta | 0..1 | MRMeta | Metadata about a resource | |
lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
security | ΣC | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. inv-mr-meta-security-01: Medirecords supports only U, R security code |
identifier:identifierLPN | 0..1 | AULocalPrescriptionIdentifier | Local Prescription Identifier | |
status | ?!ΣC | 1..1 | code | Indicates if document is Active(current) or Inactive(entered-in-error) Binding: DocumentReferenceStatus (required): The status of the document reference. inv-mr-docref-in-status-01: MediRecords supports only current - 'This is the current reference for this document' or entered-in-error - 'This reference was created in error' |
docStatus | Σ | 0..1 | code | Indicates if the document is Unchecked/Draft (preliminary) or Checked/Final (final) or Amended (amended) or Cancelled/Rejected (entered-in-error) Binding: CompositionStatus (required): Status of the underlying document. |
type | Σ | 1..1 | CodeableConcept | Prescription for medication Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. |
category | Σ | 1..1 | CodeableConcept | Prescription for medication Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 57833-6 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Prescription for medication | |
subject | Σ | 1..1 | Reference(MR Patient) | The patient who is the subject of the document |
date | Σ | 1..1 | instant | Prescription date |
author | Σ | 1..1 | Reference(MR Practitioner) | Author of prescription |
custodian | 1..1 | Reference(MR Organisation) | Organization which maintains the document | |
content | Σ | 1..* | BackboneElement | Document referenced |
attachment | Σ | 1..1 | Attachment | Where to access the document |
contentType | Σ | 1..1 | code | application/pdf Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/pdf |
data | 0..1 | base64Binary | Data inline, base64ed | |
size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) |
title | Σ | 0..1 | string | The file name of the attachment |
context | Σ | 0..1 | BackboneElement | Clinical context of document |
encounter | 0..1 | Reference(MR Encounter | MR Encounter Admission) | Context of the document content | |
related:prescription | 0..1 | Reference(MedicationRequest) | Reference to related prescription MedicationRequest | |
Documentation for this format |
This structure is derived from MRDocumentReference
Summary
Mandatory: 4 elements
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from MRDocumentReference
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentReference | 0..* | MRDocumentReference | A reference to a document | |
Slices for identifier | 0..* | Identifier | Other identifiers for the document Slice: Unordered, Open by pattern:type | |
identifier:identifierLPN | S | 0..1 | AULocalPrescriptionIdentifier | Local Prescription Identifier |
system | 1..1 | uri | MediRecords tenant ID prefixed with 'urn:uuid:' | |
value | 1..1 | string | MediRecords script number, e.g. 4010 | |
assigner | ||||
display | 1..1 | string | MediRecords tenant name | |
type | 1..1 | CodeableConcept | Prescription for medication | |
category | 1..1 | CodeableConcept | Prescription for medication Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 57833-6 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Prescription for medication | |
date | 1..1 | instant | Prescription date | |
author | S | 1..1 | Reference(MR Practitioner) | Author of prescription |
content | ||||
attachment | ||||
contentType | 1..1 | code | application/pdf Required Pattern: application/pdf | |
context | ||||
Slices for related | 0..* | Reference(Resource) | Related identifiers or resources Slice: Unordered, Open by type:$this | |
related:prescription | S | 0..1 | Reference(MedicationRequest) | Reference to related prescription MedicationRequest |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
DocumentReference | 0..* | MRDocumentReference | A reference to a document | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | S | 0..1 | MRMeta | Metadata about a resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | SΣC | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. inv-mr-meta-security-01: Medirecords supports only U, R security code | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
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 | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
recipient | 0..1 | Reference(MR Practitioner | MR Organisation | MR Patient | MR PractitionerRole) | MR DocumentReference Recipient Extension URL: https://fhir.medirecords.com/StructureDefinition/mr-document-ref-recipient-extn | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "https://fhir.medirecords.com/StructureDefinition/mr-document-ref-recipient-extn" | |||||
Slices for value[x] | 1..1 | Reference(MR Practitioner | MR Organisation | MR Patient | MR PractitionerRole) | Document recipient Slice: Unordered, Closed by type:$this | |||||
value[x]:valueReference | 1..1 | Reference(MR Practitioner | MR Organisation | MR Patient) | Document recipient | |||||
documentTitle | 0..1 | string | MR DocumentReference Title Extension URL: https://fhir.medirecords.com/StructureDefinition/mr-document-ref-title-extn | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
masterIdentifier | Σ | 0..1 | Identifier | Master Version Specific Identifier | ||||
Slices for identifier | Σ | 0..* | Identifier | Other identifiers for the document Slice: Unordered, Open by pattern:type | ||||
identifier:identifierLPN | S | 0..1 | AULocalPrescriptionIdentifier | Local Prescription Identifier | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Coded identifier type for local prescription 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. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: LPN | |||||
display | 0..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 | |||||
system | Σ | 1..1 | uri | MediRecords tenant ID prefixed with 'urn:uuid:' Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | MediRecords script number, e.g. 4010 Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 1..1 | Reference(Organization) | Organisation that assigned the prescription identifier | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 1..1 | string | MediRecords tenant name | ||||
status | ?!SΣC | 1..1 | code | Indicates if document is Active(current) or Inactive(entered-in-error) Binding: DocumentReferenceStatus (required): The status of the document reference. inv-mr-docref-in-status-01: MediRecords supports only current - 'This is the current reference for this document' or entered-in-error - 'This reference was created in error' | ||||
docStatus | SΣ | 0..1 | code | Indicates if the document is Unchecked/Draft (preliminary) or Checked/Final (final) or Amended (amended) or Cancelled/Rejected (entered-in-error) Binding: CompositionStatus (required): Status of the underlying document. | ||||
type | SΣ | 1..1 | CodeableConcept | Prescription for medication Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. | ||||
category | SΣ | 1..1 | CodeableConcept | Prescription for medication Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 57833-6 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Prescription for medication | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
subject | SΣ | 1..1 | Reference(MR Patient) | The patient who is the subject of the document | ||||
date | SΣ | 1..1 | instant | Prescription date | ||||
author | SΣ | 1..1 | Reference(MR Practitioner) | Author of prescription | ||||
authenticator | 0..1 | Reference(MR Practitioner) | The user from the practice who checked the document on upload | |||||
custodian | S | 1..1 | Reference(MR Organisation) | 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 | SΣ | 1..1 | code | application/pdf Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/pdf | ||||
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 | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
size | SΣ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
title | SΣ | 0..1 | string | The file name of the attachment 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..1 | Reference(MR Encounter | MR Encounter Admission) | 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 | Σ | 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 | |||||
Slices for related | 0..* | Reference(Resource) | Related identifiers or resources Slice: Unordered, Open by type:$this | |||||
related:prescription | S | 0..1 | Reference(MedicationRequest) | Reference to related prescription MedicationRequest | ||||
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet / Code | URI | |||
DocumentReference.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
DocumentReference.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
DocumentReference.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
DocumentReference.identifier:identifierLPN.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
DocumentReference.identifier:identifierLPN.type | extensible | Pattern: LPNhttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
DocumentReference.identifier:identifierLPN.assigner.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 from the FHIR Standard | ||||
DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard | ||||
DocumentReference.type | preferred | DocumentTypeValueSethttp://hl7.org/fhir/ValueSet/c80-doc-typecodes from the FHIR Standard | ||||
DocumentReference.category | example | Pattern: LOINC code 57833-6("Prescription for medication")http://hl7.org/fhir/ValueSet/document-classcodes from the FHIR Standard | ||||
DocumentReference.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | ||||
DocumentReference.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
DocumentReference.content.attachment.contentType | required | Pattern: application/pdfhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard | ||||
DocumentReference.content.attachment.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from 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/formatcodes from the FHIR Standard | ||||
DocumentReference.context.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
DocumentReference.context.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodes from the FHIR Standard | ||||
DocumentReference.context.practiceSetting | example | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from 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() | |
inv-mr-docref-in-status-01 | error | DocumentReference.status | MediRecords supports only current - 'This is the current reference for this document' or entered-in-error - 'This reference was created in error' : $this.exists() implies ($this = 'current' or $this = 'entered-in-error') | |
inv-mr-meta-security-01 | error | DocumentReference.meta.security | Medirecords supports only U, R security code : code.exists() implies (code = 'U' or code = 'R') |