Left: | Document Reference Attachment (http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/cmc-document-reference) |
Right: | Document Reference Attachment (http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/cmc-document-reference) |
Error | StructureDefinition.version | Values for version differ: '1.0.0-ballot' vs '1.0.0' |
Information | StructureDefinition.date | Values for date differ: '2024-04-08T17:51:06+00:00' vs '2024-12-11T14:20:21+00:00' |
Warning | StructureDefinition.abstract | Values for abstract differ: 'false' vs 'true' |
Information | StructureDefinition.short | Values for short differ: 'Where to access the document' vs 'Content in a format defined elsewhere' |
Information | StructureDefinition.definition | Values for definition differ: 'The document or URL of the document along with critical metadata to prove content has integrity.' vs 'For referring to data content defined in other formats.' |
Name | Value | Comments | |
---|---|---|---|
abstract | false | true |
|
baseDefinition | http://hl7.org/fhir/StructureDefinition/DocumentReference | ||
copyright | |||
date | 2024-04-08T17:51:06+00:00 | 2024-12-11T14:20:21+00:00 |
|
description | A profile that represents the document or diagram in base64. | ||
experimental | |||
fhirVersion | 5.0.0 | ||
jurisdiction | |||
jurisdiction[0] | urn:iso:std:iso:3166#US | ||
kind | resource | ||
name | Base64DocumentReference | ||
publisher | HL7 International / Biomedical Research and Regulation | ||
purpose | |||
status | active | ||
title | Document Reference Attachment | ||
type | DocumentReference | ||
url | http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/cmc-document-reference | ||
version | 1.0.0-ballot | 1.0.0 |
|
Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
DocumentReference | C | 0..* | DocumentReference | A reference to a document docRef-1: facilityType SHALL only be present if context is not an encounter docRef-2: practiceSetting SHALL only be present if context is not present | C | 0..* | DocumentReference | This is an abstractprofile. Childprofiles: GraphicReference, StructureReference A reference to a document docRef-1: facilityType SHALL only be present if context is not an encounter docRef-2: practiceSetting SHALL only be present if context is not present | |||||||||
id | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |||||||||
meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||
id | 0..1 | id | Unique id for inter-element referencing |
| |||||||||||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| |||||||||||||
versionId | Σ | 0..1 | id | Version specific identifier |
| ||||||||||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| ||||||||||||
source | Σ | 0..1 | uri | Identifies where the resource comes from |
| ||||||||||||
profile | SΣ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| ||||||||||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: ?? (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| ||||||||||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: ?? (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 | ?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||
language | 0..1 | code | Language of the resource content Binding: ?? (required): IETF language tag for a human language
| 0..1 | code | Language of the resource content Binding: ?? (required): IETF language tag for a human language
| |||||||||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||
contained | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | |||||||||
identifier | Σ | 0..* | Identifier | Business identifiers for the document | Σ | 0..* | Identifier | Business identifiers for the document | |||||||||
version | Σ | 0..1 | string | An explicitly assigned identifer of a variation of the content in the DocumentReference | Σ | 0..1 | string | An explicitly assigned identifer of a variation of the content in the DocumentReference | |||||||||
basedOn | 0..* | Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | VisionPrescription) | Procedure that caused this media to be created | 0..* | Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | VisionPrescription) | Procedure that caused this media to be created | |||||||||||
status | ?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: ?? (required): The status of the document reference. Required Pattern: current | ?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: ?? (required): The status of the document reference. Required Pattern: current | |||||||||
docStatus | Σ | 0..1 | code | registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown Binding: ?? (required): Status of the underlying document. | Σ | 0..1 | code | registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown Binding: ?? (required): Status of the underlying document. | |||||||||
modality | Σ | 0..* | CodeableConcept | Imaging modality used Binding: ?? (extensible): Type of acquired data in the instance. | Σ | 0..* | CodeableConcept | Imaging modality used Binding: ?? (extensible): Type of acquired data in the instance. | |||||||||
type | Σ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: ?? (preferred): Precise type of clinical document. | Σ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: ?? (preferred): Precise type of clinical document. | |||||||||
category | Σ | 0..* | CodeableConcept | Categorization of document Binding: ?? (example): High-level kind of document at a macro level. | Σ | 0..* | CodeableConcept | Categorization of document Binding: ?? (example): High-level kind of document at a macro level. | |||||||||
subject | Σ | 0..1 | Reference(Resource) | Who/what is the subject of the document | Σ | 0..1 | Reference(Resource) | Who/what is the subject of the document | |||||||||
context | C | 0..* | Reference(Appointment | Encounter | EpisodeOfCare) | Context of the document content | C | 0..* | Reference(Appointment | Encounter | EpisodeOfCare) | Context of the document content | |||||||||
event | 0..* | CodeableReference() | Main clinical acts documented Binding: ?? (example): This list of codes represents the main clinical acts being documented. | 0..* | CodeableReference() | Main clinical acts documented Binding: ?? (example): This list of codes represents the main clinical acts being documented. | |||||||||||
bodySite | Σ | 0..* | CodeableReference(BodyStructure) | Body part included Binding: ?? (example): SNOMED CT Body site concepts | Σ | 0..* | CodeableReference(BodyStructure) | Body part included Binding: ?? (example): SNOMED CT Body site concepts | |||||||||
facilityType | C | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: ?? (example): XDS Facility Type. | C | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: ?? (example): XDS Facility Type. | |||||||||
practiceSetting | C | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: ?? (example): Additional details about where the content was created (e.g. clinical specialty). | C | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: ?? (example): Additional details about where the content was created (e.g. clinical specialty). | |||||||||
period | Σ | 0..1 | Period | Time of service that is being documented | Σ | 0..1 | Period | Time of service that is being documented | |||||||||
date | Σ | 0..1 | instant | When this document reference was created | Σ | 0..1 | instant | When this document reference was created | |||||||||
author | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) | Who and/or what authored the document | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) | Who and/or what authored the document | |||||||||
attester | 0..* | BackboneElement | Attests to accuracy of the document | 0..* | BackboneElement | Attests to accuracy of the document | |||||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
mode | 1..1 | CodeableConcept | personal | professional | legal | official Binding: ?? (preferred): The way in which a person authenticated a document. | 1..1 | CodeableConcept | personal | professional | legal | official Binding: ?? (preferred): The way in which a person authenticated a document. | |||||||||||
time | 0..1 | dateTime | When the document was attested | 0..1 | dateTime | When the document was attested | |||||||||||
party | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the document | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the document | |||||||||||
custodian | 0..1 | Reference(Organization) | Organization which maintains the document | 0..1 | Reference(Organization) | Organization which maintains the document | |||||||||||
relatesTo | Σ | 0..* | BackboneElement | Relationships to other documents | Σ | 0..* | BackboneElement | Relationships to other documents | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
code | Σ | 1..1 | CodeableConcept | The relationship type with another document Binding: ?? (extensible): The type of relationship between the documents. | Σ | 1..1 | CodeableConcept | The relationship type with another document Binding: ?? (extensible): The type of relationship between the documents. | |||||||||
target | Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | |||||||||
description | Σ | 0..1 | markdown | Human-readable description | Σ | 0..1 | markdown | Human-readable description | |||||||||
securityLabel | Σ | 0..* | CodeableConcept | Document security-tags Binding: ?? (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | Σ | 0..* | CodeableConcept | Document security-tags Binding: ?? (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | |||||||||
content | SΣ | 1..* | BackboneElement | Document referenced | SΣ | 1..* | BackboneElement | Document referenced | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
attachment | SΣ | 1..1 | Attachment | Where to access the document | SC | 1..1 | ?? | Content in a format defined elsewhere att-1: If the Attachment has data, it SHALL have a contentType | |||||||||
id | 0..1 | id | Unique id for inter-element referencing |
| |||||||||||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| |||||||||||||
contentType | SΣC | 1..1 | code | Mime type of the content, with charset etc. Binding: ?? (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Example General: text/plain; charset=UTF-8, image/png |
| ||||||||||||
language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: ?? (required): IETF language tag for a human language.
Example General: en-AU |
| ||||||||||||
data | SC | 1..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 | Σ | 0..1 | integer64 | Number of bytes of content (if url provided) |
| ||||||||||||
hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) |
| ||||||||||||
title | SΣ | 1..1 | string | Document file name including the file extension Example General: Official Corporate Logo |
| ||||||||||||
creation | Σ | 0..1 | dateTime | Date attachment was first created |
| ||||||||||||
height | 0..1 | positiveInt | Height of the image in pixels (photo/video) |
| |||||||||||||
width | 0..1 | positiveInt | Width of the image in pixels (photo/video) |
| |||||||||||||
frames | 0..1 | positiveInt | Number of frames if > 1 (photo) |
| |||||||||||||
duration | 0..1 | decimal | Length in seconds (audio / video) |
| |||||||||||||
pages | 0..1 | positiveInt | Number of printed pages |
| |||||||||||||
profile | Σ | 0..* | BackboneElement | Content profile rules for the document | Σ | 0..* | BackboneElement | Content profile rules for the document | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
value[x] | Σ | 1..1 | Coding, uri, canonical() | Code|uri|canonical Binding: ?? (preferred): Document Format Codes. | Σ | 1..1 | Coding, uri, canonical() | Code|uri|canonical Binding: ?? (preferred): Document Format Codes. | |||||||||
Documentation for this format |