LuxithDocumentReferenceProfile
⚠️ This is an introduction of our profile LuxithDocumentReferenceProfile
Metadata
These are the details for this resource:
Resource content
These are different views on this resource:
| DocumentReference | |
| Definition | A reference to a document of any kind for any purpose. While the term “document” implies a more narrow focus, for this resource this "document" encompasses *any* serialized object with a mime-type, it includes formal patient-centric documents (CDA), clinical notes, scanned paper, non-patient specific documents like policy text, as well as a photo, video, or audio recording acquired or used in healthcare. The DocumentReference resource provides metadata about the document so that the document can be discovered and managed. The actual content may be inline base64 encoded data or provided by direct reference. |
| Cardinality | 0...* |
| Comments | Usually, this is used for documents other than those defined by FHIR. |
| Invariants |
|
| Mappings |
|
| DocumentReference.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Cardinality | 0...1 |
| Type | id |
| Summary | True |
| Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| DocumentReference.meta | |
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
| Cardinality | 0...1 |
| Type | Meta |
| Summary | True |
| Invariants |
|
| Mappings |
|
| DocumentReference.implicitRules | |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| Cardinality | 0...1 |
| Type | uri |
| Modifier | True |
| Summary | True |
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. |
| Invariants |
|
| Mappings |
|
| DocumentReference.language | |
| Definition | The base language in which the resource is written. |
| Cardinality | 0...1 |
| Type | code |
| Binding | IETF language tag for a human language |
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
| Invariants |
|
| Mappings |
|
| DocumentReference.text | |
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
| Cardinality | 0...1 |
| Type | Narrative |
| Alias | narrative, html, xhtml, display |
| Comments | Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
| Invariants |
|
| Mappings |
|
| DocumentReference.contained | |
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
| Cardinality | 0...* |
| Type | Resource |
| Alias | inline resources, anonymous resources, contained resources |
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. |
| Mappings |
|
| DocumentReference.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0...* |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) |
| Invariants |
|
| Mappings |
|
| DocumentReference.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Cardinality | 0...* |
| Type | Extension |
| Modifier | True |
| Summary | True |
| Alias | extensions, user content |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) |
| Invariants |
|
| Mappings |
|
| DocumentReference.identifier | |
| Definition | Other business identifiers associated with the document, including version independent identifiers. |
| Cardinality | 0...* |
| Type | Identifier |
| Summary | True |
| Requirements | Document identifiers usually assigned by the source of the document, or other business identifiers such as XDS DocumentEntry.uniqueId and DocumentEntry.entryUUID. These identifiers are specific to this instance of the document. |
| Comments | The structure and format of this identifier would be consistent with the specification corresponding to the format of the document. (e.g. for a DICOM standard document, a 64-character numeric UID; for an HL7 CDA format, the CDA Document Id root and extension). |
| Slicing | Unordered, Open, by $this(Pattern) |
| Invariants |
|
| Mappings |
|
| DocumentReference.version | |
| Definition | An explicitly assigned identifer of a variation of the content in the DocumentReference. |
| Cardinality | 0...0 |
| Type | string |
| Summary | True |
| Comments | While each resource, including the DocumentReference itself, has its own version identifier, this is a formal identifier for the logical version of the DocumentReference as a whole. It would remain constant if the resources were moved to a new server, and all got new individual resource versions, for example. |
| Invariants |
|
| Mappings |
|
| DocumentReference.basedOn | |
| Definition | A procedure that is fulfilled in whole or in part by the creation of this media. |
| Cardinality | 0...0 |
| Type | Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | VisionPrescription) |
| Alias | fulfills |
| Requirements | Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Invariants |
|
| Mappings |
|
| DocumentReference.status | |
| Definition | The status of this document reference. |
| Cardinality | 1...1 |
| Type | code |
| Binding | The status of the document reference. |
| Modifier | True |
| Summary | True |
| Comments | This is the status of the DocumentReference object, which might be independent from the docStatus element. This element is labeled as a modifier because the status contains the codes that mark the document or reference as not currently valid. |
| Invariants |
|
| Mappings |
|
| DocumentReference.docStatus | |
| Definition | The status of the underlying document. |
| Cardinality | 1...1 |
| Type | code |
| Binding | Status of the underlying document. |
| Summary | True |
| Comments | The document that is pointed to might be in various lifecycle states. |
| Invariants |
|
| Mappings |
|
| DocumentReference.modality | |
| Definition | Imaging modality used. This may include both acquisition and non-acquisition modalities. |
| Cardinality | 0...0 |
| Type | CodeableConcept |
| Binding | Type of acquired data in the instance. |
| Summary | True |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Invariants |
|
| Mappings |
|
| DocumentReference.type | |
| Definition | Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced. |
| Cardinality | 1...1 |
| Type | CodeableConcept |
| Binding | Precise type of clinical document. |
| Summary | True |
| Comments | Key metadata element describing the document that describes he exact type of document. Helps humans to assess whether the document is of interest when viewing a list of documents. |
| Invariants |
|
| Mappings |
|
| DocumentReference.type.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0...1 |
| Type | string |
| Mappings |
|
| DocumentReference.type.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0...* |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) |
| Invariants |
|
| Mappings |
|
| DocumentReference.type.coding | |
| Definition | A reference to a code defined by a terminology system. |
| Cardinality | 1...1 |
| Type | Coding |
| Summary | True |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Invariants |
|
| Mappings |
|
| DocumentReference.type.coding.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0...1 |
| Type | string |
| Mappings |
|
| DocumentReference.type.coding.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0...* |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) |
| Invariants |
|
| Mappings |
|
| DocumentReference.type.coding.system | |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Cardinality | 0...0 |
| Type | uri |
| Summary | True |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. |
| Invariants |
|
| Mappings |
|
| DocumentReference.type.coding.version | |
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
| Cardinality | 0...0 |
| Type | string |
| Summary | True |
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
| Invariants |
|
| Mappings |
|
| DocumentReference.type.coding.code | |
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
| Cardinality | 0...1 |
| Type | code |
| Summary | True |
| Requirements | Need to refer to a particular code in the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Invariants |
|
| Mappings |
|
| DocumentReference.type.coding.display | |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. |
| Cardinality | 0...0 |
| Type | string |
| Summary | True |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Invariants |
|
| Mappings |
|
| DocumentReference.type.coding.userSelected | |
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
| Cardinality | 0...0 |
| Type | boolean |
| Summary | True |
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
| Invariants |
|
| Mappings |
|
| DocumentReference.type.text | |
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
| Cardinality | 1...1 |
| Type | string |
| Summary | True |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Invariants |
|
| Mappings |
|
| DocumentReference.category | |
| Definition | A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type. |
| Cardinality | 0...0 |
| Type | CodeableConcept |
| Binding | High-level kind of document at a macro level. |
| Summary | True |
| Alias | class, classCode |
| Comments | Key metadata element describing the the category or classification of the document. This is a broader perspective that groups similar documents based on how they would be used. This is a primary key used in searching. |
| Invariants |
|
| Mappings |
|
| DocumentReference.category.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0...1 |
| Type | string |
| Mappings |
|
| DocumentReference.category.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0...* |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) |
| Invariants |
|
| Mappings |
|
| DocumentReference.category.coding | |
| Definition | A reference to a code defined by a terminology system. |
| Cardinality | 0...* |
| Type | Coding |
| Summary | True |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Invariants |
|
| Mappings |
|
| DocumentReference.category.coding.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0...1 |
| Type | string |
| Mappings |
|
| DocumentReference.category.coding.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0...* |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) |
| Invariants |
|
| Mappings |
|
| DocumentReference.category.coding.system | |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Cardinality | 0...0 |
| Type | uri |
| Summary | True |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. |
| Invariants |
|
| Mappings |
|
| DocumentReference.category.coding.version | |
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
| Cardinality | 0...0 |
| Type | string |
| Summary | True |
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
| Invariants |
|
| Mappings |
|
| DocumentReference.category.coding.code | |
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
| Cardinality | 0...1 |
| Type | code |
| Summary | True |
| Requirements | Need to refer to a particular code in the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Invariants |
|
| Mappings |
|
| DocumentReference.category.coding.display | |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. |
| Cardinality | 0...1 |
| Type | string |
| Summary | True |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Invariants |
|
| Mappings |
|
| DocumentReference.category.coding.userSelected | |
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
| Cardinality | 0...0 |
| Type | boolean |
| Summary | True |
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
| Invariants |
|
| Mappings |
|
| DocumentReference.category.text | |
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
| Cardinality | 1...1 |
| Type | string |
| Summary | True |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Invariants |
|
| Mappings |
|
| DocumentReference.subject | |
| Definition | Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure). |
| Cardinality | 0...1 |
| Type | Reference(Resource) |
| Summary | True |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Invariants |
|
| Mappings |
|
| DocumentReference.context | |
| Definition | Describes the clinical encounter or type of care that the document content is associated with. |
| Cardinality | 0...* |
| Type | Reference(Appointment | Encounter | EpisodeOfCare) |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Invariants |
|
| Mappings |
|
| DocumentReference.event | |
| Definition | This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act. |
| Cardinality | 0...1 |
| Type | CodeableReference() |
| Binding | This list of codes represents the main clinical acts being documented. |
| Comments | An event can further specialize the act inherent in the type, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more event codes are included, they shall not conflict with the values inherent in the class or type elements as such a conflict would create an ambiguous situation. |
| Invariants |
|
| Mappings |
|
| DocumentReference.bodySite | |
| Definition | The anatomic structures included in the document. |
| Cardinality | 0...0 |
| Type | CodeableReference(BodyStructure) |
| Binding | SNOMED CT Body site concepts |
| Summary | True |
| Invariants |
|
| Mappings |
|
| DocumentReference.facilityType | |
| Definition | The kind of facility where the patient was seen. |
| Cardinality | 0...1 |
| Type | CodeableConcept |
| Binding | XDS Facility Type. |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Invariants |
|
| Mappings |
|
| DocumentReference.facilityType.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0...1 |
| Type | string |
| Mappings |
|
| DocumentReference.facilityType.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0...* |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) |
| Invariants |
|
| Mappings |
|
| DocumentReference.facilityType.coding | |
| Definition | A reference to a code defined by a terminology system. |
| Cardinality | 0...0 |
| Type | Coding |
| Summary | True |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Invariants |
|
| Mappings |
|
| DocumentReference.facilityType.text | |
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
| Cardinality | 1...1 |
| Type | string |
| Summary | True |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Invariants |
|
| Mappings |
|
| DocumentReference.practiceSetting | |
| Definition | This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty. |
| Cardinality | 0...0 |
| Type | CodeableConcept |
| Binding | Additional details about where the content was created (e.g. clinical specialty). |
| Requirements | This is an important piece of metadata that providers often rely upon to quickly sort and/or filter out to find specific content. |
| Comments | This element should be based on a coarse classification system for the class of specialty practice. Recommend the use of the classification system for Practice Setting, such as that described by the Subject Matter Domain in LOINC. |
| Invariants |
|
| Mappings |
|
| DocumentReference.period | |
| Definition | The time period over which the service that is described by the document was provided. |
| Cardinality | 0...0 |
| Type | Period |
| Summary | True |
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
| Invariants |
|
| Mappings |
|
| DocumentReference.date | |
| Definition | When the document reference was created. |
| Cardinality | 0...1 |
| Type | instant |
| Summary | True |
| Alias | indexed |
| Comments | Referencing/indexing time is used for tracking, organizing versions and searching. |
| Invariants |
|
| Mappings |
|
| DocumentReference.author | |
| Definition | Identifies who is responsible for adding the information to the document. |
| Cardinality | 0...1 |
| Type | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) |
| Summary | True |
| Comments | Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant). |
| Invariants |
|
| Mappings |
|
| DocumentReference.attester | |
| Definition | A participant who has authenticated the accuracy of the document. |
| Cardinality | 0...0 |
| Type | BackboneElement |
| Requirements | Identifies responsibility for the accuracy of the document content. |
| Comments | Only list each attester once. |
| Invariants |
|
| Mappings |
|
| DocumentReference.attester.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0...1 |
| Type | string |
| Mappings |
|
| DocumentReference.attester.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0...* |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) |
| Invariants |
|
| Mappings |
|
| DocumentReference.attester.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Cardinality | 0...* |
| Type | Extension |
| Modifier | True |
| Summary | True |
| Alias | extensions, user content, modifiers |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Invariants |
|
| Mappings |
|
| DocumentReference.attester.mode | |
| Definition | The type of attestation the authenticator offers. |
| Cardinality | 1...1 |
| Type | CodeableConcept |
| Binding | The way in which a person authenticated a document. |
| Requirements | Indicates the level of authority of the attestation. |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Invariants |
|
| Mappings |
|
| DocumentReference.attester.time | |
| Definition | When the document was attested by the party. |
| Cardinality | 0...1 |
| Type | dateTime |
| Requirements | Identifies when the information in the document was deemed accurate. (Things may have changed since then.). |
| Comments | UTC offset is allowed for dates and partial dates |
| Invariants |
|
| Mappings |
|
| DocumentReference.attester.party | |
| Definition | Who attested the document in the specified way. |
| Cardinality | 0...1 |
| Type | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) |
| Requirements | Identifies who has taken on the responsibility for accuracy of the document content. |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Invariants |
|
| Mappings |
|
| DocumentReference.custodian | |
| Definition | Identifies the organization or group who is responsible for ongoing maintenance of and access to the document. |
| Cardinality | 0...1 |
| Type | Reference(Organization) |
| Comments | Identifies the logical organization (software system, vendor, or department) to go to find the current version, where to report issues, etc. This is different from the physical location (URL, disk drive, or server) of the document, which is the technical location of the document, which host may be delegated to the management of some other organization. |
| Invariants |
|
| Mappings |
|
| DocumentReference.relatesTo | |
| Definition | Relationships that this document has with other document references that already exist. |
| Cardinality | 0...0 |
| Type | BackboneElement |
| Summary | True |
| Comments | This element is labeled as a modifier because documents that append to other documents are incomplete on their own. |
| Invariants |
|
| Mappings |
|
| DocumentReference.relatesTo.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0...1 |
| Type | string |
| Mappings |
|
| DocumentReference.relatesTo.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0...* |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) |
| Invariants |
|
| Mappings |
|
| DocumentReference.relatesTo.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Cardinality | 0...* |
| Type | Extension |
| Modifier | True |
| Summary | True |
| Alias | extensions, user content, modifiers |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Invariants |
|
| Mappings |
|
| DocumentReference.relatesTo.code | |
| Definition | The type of relationship that this document has with anther document. |
| Cardinality | 1...1 |
| Type | CodeableConcept |
| Binding | The type of relationship between the documents. |
| Summary | True |
| Comments | If this document appends another document, then the document cannot be fully understood without also accessing the referenced document. |
| Invariants |
|
| Mappings |
|
| DocumentReference.relatesTo.target | |
| Definition | The target document of this relationship. |
| Cardinality | 1...1 |
| Type | Reference(DocumentReference) |
| Summary | True |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Invariants |
|
| Mappings |
|
| DocumentReference.description | |
| Definition | Human-readable description of the source document. |
| Cardinality | 0...1 |
| Type | markdown |
| Summary | True |
| Requirements | Helps humans to assess whether the document is of interest. |
| Comments | What the document is about, a terse summary of the document. |
| Invariants |
|
| Mappings |
|
| DocumentReference.securityLabel | |
| Definition | A set of Security-Tag codes specifying the level of privacy/security of the Document found at DocumentReference.content.attachment.url. Note that DocumentReference.meta.security contains the security labels of the data elements in DocumentReference, while DocumentReference.securityLabel contains the security labels for the document the reference refers to. The distinction recognizes that the document may contain sensitive information, while the DocumentReference is metadata about the document and thus might not be as sensitive as the document. For example: a psychotherapy episode may contain highly sensitive information, while the metadata may simply indicate that some episode happened. |
| Cardinality | 0...1 |
| Type | CodeableConcept |
| Binding | Example Security Labels from the Healthcare Privacy and Security Classification System. |
| Summary | True |
| Requirements | Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended. |
| Comments | The confidentiality codes can carry multiple vocabulary items. HL7 has developed an understanding of security and privacy tags that might be desirable in a Document Sharing environment, called HL7 Healthcare Privacy and Security Classification System (HCS). The following specification is recommended but not mandated, as the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as the XDS Affinity Domain or other Trust Domain where all parties including sender and recipients are trusted to appropriately tag and enforce. In the HL7 Healthcare Privacy and Security Classification (HCS) there are code systems specific to Confidentiality, Sensitivity, Integrity, and Handling Caveats. Some values would come from a local vocabulary as they are related to workflow roles and special projects. |
| Invariants |
|
| Mappings |
|
| DocumentReference.content | |
| Definition | The document and format referenced. If there are multiple content element repetitions, these must all represent the same document in different format, or attachment metadata. |
| Cardinality | 1...* |
| Type | BackboneElement |
| Summary | True |
| Requirements | Note that .relatesTo may also include references to other DocumentReference with a transforms relationship to represent the same document in multiple formats. |
| Comments | content element shall not contain different versions of the same content. For version handling use multiple DocumentReference with .relatesTo. |
| Invariants |
|
| Mappings |
|
| DocumentReference.content.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0...1 |
| Type | string |
| Mappings |
|
| DocumentReference.content.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0...1 |
| Type | Extension |
| Alias | extensions, user content |
| Requirements | This extension holds an AES key that has been encrypted with an RSA public key |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) |
| Invariants |
|
| Mappings |
|
| DocumentReference.content.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Cardinality | 0...0 |
| Type | Extension |
| Modifier | True |
| Summary | True |
| Alias | extensions, user content, modifiers |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Invariants |
|
| Mappings |
|
| DocumentReference.content.attachment | |
| Definition | The document or URL of the document along with critical metadata to prove content has integrity. |
| Cardinality | 1...1 |
| Type | Attachment |
| Summary | True |
| Comments | When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent". |
| Invariants |
|
| Mappings |
|
| DocumentReference.content.attachment.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0...1 |
| Type | string |
| Mappings |
|
| DocumentReference.content.attachment.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0...* |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) |
| Invariants |
|
| Mappings |
|
| DocumentReference.content.attachment.contentType | |
| Definition | Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate. |
| Cardinality | 1...1 |
| Type | code |
| Binding | BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) |
| Summary | True |
| Requirements | Processors of the data need to be able to know how to interpret the data. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Invariants |
|
| Examples | General text/plain; charset=UTF-8, image/png |
| Mappings |
|
| DocumentReference.content.attachment.language | |
| Definition | The human language of the content. The value can be any valid value according to BCP 47. |
| Cardinality | 0...0 |
| Type | code |
| Binding | IETF language tag for a human language. |
| Summary | True |
| Requirements | Users need to be able to choose between the languages in a set of attachments. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Invariants |
|
| Examples | General en-AU |
| Mappings |
|
| DocumentReference.content.attachment.data | |
| Definition | The actual data of the attachment - a sequence of bytes, base64 encoded. |
| Cardinality | 1...1 |
| Type | base64Binary |
| Requirements | The data needs to able to be transmitted inline. |
| Comments | The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON. |
| Invariants |
|
| Mappings |
|
| DocumentReference.content.attachment.url | |
| Definition | A location where the data can be accessed. |
| Cardinality | 0...1 |
| Type | url |
| Summary | True |
| Requirements | The data needs to be transmitted by reference. |
| Comments | If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data. |
| Invariants |
|
| Examples | General http://www.acme.com/logo-small.png |
| Mappings |
|
| DocumentReference.content.attachment.size | |
| Definition | The number of bytes of data that make up this attachment (before base64 encoding, if that is done). |
| Cardinality | 1...1 |
| Type | integer64 |
| Summary | True |
| Requirements | Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all. |
| Comments | The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference. |
| Invariants |
|
| Mappings |
|
| DocumentReference.content.attachment.hash | |
| Definition | The calculated hash of the data using SHA-1. Represented using base64. |
| Cardinality | 0...1 |
| Type | base64Binary |
| Summary | True |
| Requirements | Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version). |
| Comments | The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature. |
| Invariants |
|
| Mappings |
|
| DocumentReference.content.attachment.title | |
| Definition | A label or set of text to display in place of the data. |
| Cardinality | 0...1 |
| Type | string |
| Summary | True |
| Requirements | Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer. |
| Comments | May sometimes be derived from the source filename. |
| Invariants |
|
| Examples | General Official Corporate Logo |
| Mappings |
|
| DocumentReference.content.attachment.creation | |
| Definition | The date that the attachment was first created. |
| Cardinality | 0...1 |
| Type | dateTime |
| Summary | True |
| Requirements | This is often tracked as an integrity issue for use of the attachment. |
| Comments | UTC offset is allowed for dates and partial dates |
| Invariants |
|
| Mappings |
|
| DocumentReference.content.attachment.height | |
| Definition | Height of the image in pixels (photo/video). |
| Cardinality | 0...0 |
| Type | positiveInt |
| Comments | 32 bit number; for values larger than this, use decimal |
| Invariants |
|
| Mappings |
|
| DocumentReference.content.attachment.width | |
| Definition | Width of the image in pixels (photo/video). |
| Cardinality | 0...0 |
| Type | positiveInt |
| Comments | 32 bit number; for values larger than this, use decimal |
| Invariants |
|
| Mappings |
|
| DocumentReference.content.attachment.frames | |
| Definition | The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required. |
| Cardinality | 0...0 |
| Type | positiveInt |
| Comments | if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated. |
| Invariants |
|
| Mappings |
|
| DocumentReference.content.attachment.duration | |
| Definition | The duration of the recording in seconds - for audio and video. |
| Cardinality | 0...0 |
| Type | decimal |
| Comments | The duration might differ from occurrencePeriod if recording was paused. |
| Invariants |
|
| Mappings |
|
| DocumentReference.content.attachment.pages | |
| Definition | The number of pages when printed. |
| Cardinality | 0...1 |
| Type | positiveInt |
| Comments | 32 bit number; for values larger than this, use decimal |
| Invariants |
|
| Mappings |
|
| DocumentReference.content.profile | |
| Definition | An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType. |
| Cardinality | 0...0 |
| Type | BackboneElement |
| Summary | True |
| Alias | format, formatCode |
| Comments | Note that IHE often issues URNs for formatCode codes, not all documents can be identified by a URI. For FHIR content, .profile should indicate the structureDefinition profile canonical URI(s) that the content complies with. |
| Invariants |
|
| Mappings |
|
| DocumentReference.content.profile.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0...1 |
| Type | string |
| Mappings |
|
| DocumentReference.content.profile.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0...* |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) |
| Invariants |
|
| Mappings |
|
| DocumentReference.content.profile.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Cardinality | 0...* |
| Type | Extension |
| Modifier | True |
| Summary | True |
| Alias | extensions, user content, modifiers |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Invariants |
|
| Mappings |
|
| DocumentReference.content.profile.value[x] | |
| Definition | Code|uri|canonical. |
| Cardinality | 1...1 |
| Type | Coding |
| Binding | Document Format Codes. |
| Summary | True |
| Invariants |
|
| Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <text> <status value="generated" /> --- We have skipped the narrative for better readability of the resource --- </text> <url value="https://luxith-etab.org/fhir/StructureDefinition/lu/LuxithDocumentReferenceProfile" /> <name value="LuxithDocumentReferenceProfile" /> <status value="draft" /> <fhirVersion value="5.0.0" /> <kind value="resource" /> <abstract value="false" /> <type value="DocumentReference" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/DocumentReference" /> <derivation value="constraint" /> <differential> <element id="DocumentReference.identifier"> <path value="DocumentReference.identifier" /> <slicing> <discriminator> <type value="pattern" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> </element> <element id="DocumentReference.version"> <path value="DocumentReference.version" /> <max value="0" /> </element> <element id="DocumentReference.basedOn"> <path value="DocumentReference.basedOn" /> <max value="0" /> </element> <element id="DocumentReference.docStatus"> <path value="DocumentReference.docStatus" /> <min value="1" /> </element> <element id="DocumentReference.modality"> <path value="DocumentReference.modality" /> <max value="0" /> </element> <element id="DocumentReference.type"> <path value="DocumentReference.type" /> <min value="1" /> </element> <element id="DocumentReference.type.coding"> <path value="DocumentReference.type.coding" /> <min value="1" /> <max value="1" /> </element> <element id="DocumentReference.type.coding.system"> <path value="DocumentReference.type.coding.system" /> <max value="0" /> </element> <element id="DocumentReference.type.coding.version"> <path value="DocumentReference.type.coding.version" /> <max value="0" /> </element> <element id="DocumentReference.type.coding.code"> <path value="DocumentReference.type.coding.code" /> <code> <system value="http://loinc.org" /> </code> </element> <element id="DocumentReference.type.coding.display"> <path value="DocumentReference.type.coding.display" /> <max value="0" /> </element> <element id="DocumentReference.type.coding.userSelected"> <path value="DocumentReference.type.coding.userSelected" /> <max value="0" /> </element> <element id="DocumentReference.type.text"> <path value="DocumentReference.type.text" /> <min value="1" /> </element> <element id="DocumentReference.category"> <path value="DocumentReference.category" /> <max value="0" /> </element> <element id="DocumentReference.category.coding.system"> <path value="DocumentReference.category.coding.system" /> <max value="0" /> </element> <element id="DocumentReference.category.coding.version"> <path value="DocumentReference.category.coding.version" /> <max value="0" /> </element> <element id="DocumentReference.category.coding.userSelected"> <path value="DocumentReference.category.coding.userSelected" /> <max value="0" /> </element> <element id="DocumentReference.category.text"> <path value="DocumentReference.category.text" /> <min value="1" /> </element> <element id="DocumentReference.event"> <path value="DocumentReference.event" /> <max value="1" /> </element> <element id="DocumentReference.bodySite"> <path value="DocumentReference.bodySite" /> <max value="0" /> </element> <element id="DocumentReference.facilityType.coding"> <path value="DocumentReference.facilityType.coding" /> <max value="0" /> </element> <element id="DocumentReference.facilityType.text"> <path value="DocumentReference.facilityType.text" /> <min value="1" /> </element> <element id="DocumentReference.practiceSetting"> <path value="DocumentReference.practiceSetting" /> <max value="0" /> </element> <element id="DocumentReference.period"> <path value="DocumentReference.period" /> <max value="0" /> </element> <element id="DocumentReference.author"> <path value="DocumentReference.author" /> <max value="1" /> </element> <element id="DocumentReference.attester"> <path value="DocumentReference.attester" /> <max value="0" /> </element> <element id="DocumentReference.relatesTo"> <path value="DocumentReference.relatesTo" /> <max value="0" /> </element> <element id="DocumentReference.securityLabel"> <path value="DocumentReference.securityLabel" /> <max value="1" /> </element> <element id="DocumentReference.content.extension"> <path value="DocumentReference.content.extension" /> <requirements value="This extension holds an AES key that has been encrypted with an RSA public key" /> <max value="1" /> </element> <element id="DocumentReference.content.modifierExtension"> <path value="DocumentReference.content.modifierExtension" /> <max value="0" /> </element> <element id="DocumentReference.content.attachment.contentType"> <path value="DocumentReference.content.attachment.contentType" /> <min value="1" /> </element> <element id="DocumentReference.content.attachment.language"> <path value="DocumentReference.content.attachment.language" /> <max value="0" /> </element> <element id="DocumentReference.content.attachment.data"> <path value="DocumentReference.content.attachment.data" /> <min value="1" /> </element> <element id="DocumentReference.content.attachment.size"> <path value="DocumentReference.content.attachment.size" /> <min value="1" /> </element> <element id="DocumentReference.content.attachment.height"> <path value="DocumentReference.content.attachment.height" /> <max value="0" /> </element> <element id="DocumentReference.content.attachment.width"> <path value="DocumentReference.content.attachment.width" /> <max value="0" /> </element> <element id="DocumentReference.content.attachment.frames"> <path value="DocumentReference.content.attachment.frames" /> <max value="0" /> </element> <element id="DocumentReference.content.attachment.duration"> <path value="DocumentReference.content.attachment.duration" /> <max value="0" /> </element> <element id="DocumentReference.content.profile"> <path value="DocumentReference.content.profile" /> <max value="0" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "text": { "status": "generated", --- We have skipped the narrative for better readability of the resource --- }, "url": "https://luxith-etab.org/fhir/StructureDefinition/lu/LuxithDocumentReferenceProfile", "name": "LuxithDocumentReferenceProfile", "status": "draft", "fhirVersion": "5.0.0", "kind": "resource", "abstract": false, "type": "DocumentReference", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DocumentReference", "derivation": "constraint", "differential": { "element": [ { "id": "DocumentReference.identifier", "path": "DocumentReference.identifier", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "rules": "open" } }, { "id": "DocumentReference.version", "path": "DocumentReference.version", "max": "0" }, { "id": "DocumentReference.basedOn", "path": "DocumentReference.basedOn", "max": "0" }, { "id": "DocumentReference.docStatus", "path": "DocumentReference.docStatus", "min": 1 }, { "id": "DocumentReference.modality", "path": "DocumentReference.modality", "max": "0" }, { "id": "DocumentReference.type", "path": "DocumentReference.type", "min": 1 }, { "id": "DocumentReference.type.coding", "path": "DocumentReference.type.coding", "min": 1, "max": "1" }, { "id": "DocumentReference.type.coding.system", "path": "DocumentReference.type.coding.system", "max": "0" }, { "id": "DocumentReference.type.coding.version", "path": "DocumentReference.type.coding.version", "max": "0" }, { "id": "DocumentReference.type.coding.code", "path": "DocumentReference.type.coding.code", "code": [ { "system": "http://loinc.org" } ] }, { "id": "DocumentReference.type.coding.display", "path": "DocumentReference.type.coding.display", "max": "0" }, { "id": "DocumentReference.type.coding.userSelected", "path": "DocumentReference.type.coding.userSelected", "max": "0" }, { "id": "DocumentReference.type.text", "path": "DocumentReference.type.text", "min": 1 }, { "id": "DocumentReference.category", "path": "DocumentReference.category", "max": "0" }, { "id": "DocumentReference.category.coding.system", "path": "DocumentReference.category.coding.system", "max": "0" }, { "id": "DocumentReference.category.coding.version", "path": "DocumentReference.category.coding.version", "max": "0" }, { "id": "DocumentReference.category.coding.userSelected", "path": "DocumentReference.category.coding.userSelected", "max": "0" }, { "id": "DocumentReference.category.text", "path": "DocumentReference.category.text", "min": 1 }, { "id": "DocumentReference.event", "path": "DocumentReference.event", "max": "1" }, { "id": "DocumentReference.bodySite", "path": "DocumentReference.bodySite", "max": "0" }, { "id": "DocumentReference.facilityType.coding", "path": "DocumentReference.facilityType.coding", "max": "0" }, { "id": "DocumentReference.facilityType.text", "path": "DocumentReference.facilityType.text", "min": 1 }, { "id": "DocumentReference.practiceSetting", "path": "DocumentReference.practiceSetting", "max": "0" }, { "id": "DocumentReference.period", "path": "DocumentReference.period", "max": "0" }, { "id": "DocumentReference.author", "path": "DocumentReference.author", "max": "1" }, { "id": "DocumentReference.attester", "path": "DocumentReference.attester", "max": "0" }, { "id": "DocumentReference.relatesTo", "path": "DocumentReference.relatesTo", "max": "0" }, { "id": "DocumentReference.securityLabel", "path": "DocumentReference.securityLabel", "max": "1" }, { "id": "DocumentReference.content.extension", "path": "DocumentReference.content.extension", "requirements": "This extension holds an AES key that has been encrypted with an RSA public key", "max": "1" }, { "id": "DocumentReference.content.modifierExtension", "path": "DocumentReference.content.modifierExtension", "max": "0" }, { "id": "DocumentReference.content.attachment.contentType", "path": "DocumentReference.content.attachment.contentType", "min": 1 }, { "id": "DocumentReference.content.attachment.language", "path": "DocumentReference.content.attachment.language", "max": "0" }, { "id": "DocumentReference.content.attachment.data", "path": "DocumentReference.content.attachment.data", "min": 1 }, { "id": "DocumentReference.content.attachment.size", "path": "DocumentReference.content.attachment.size", "min": 1 }, { "id": "DocumentReference.content.attachment.height", "path": "DocumentReference.content.attachment.height", "max": "0" }, { "id": "DocumentReference.content.attachment.width", "path": "DocumentReference.content.attachment.width", "max": "0" }, { "id": "DocumentReference.content.attachment.frames", "path": "DocumentReference.content.attachment.frames", "max": "0" }, { "id": "DocumentReference.content.attachment.duration", "path": "DocumentReference.content.attachment.duration", "max": "0" }, { "id": "DocumentReference.content.profile", "path": "DocumentReference.content.profile", "max": "0" } ] } }