ZD Document
Resources conforming to this profile are sent by ZorgDomein as the Composition of a Bundle that is sent to deliver the referral letter or request form to the information system of the referrer and care provider. For more information read the explanation of the implementation of HL7 FHIR Documents.
The canonical URL for this profile is:
http://zorgdomein.nl/fhir/StructureDefinition/zd-document
This profile builds on Composition.
Composition | S | 0..* | Composition |
There are no (further) constraints on this element Element Id
Composition A set of resources composed into a single coherent clinical statement with clinical attestation DefinitionA set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained. While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical.
|
extension | 0..* | Extension | Element Id
Composition.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, 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. 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. Unordered, Open, by url(Value) Constraints
|
|
actingpractitioner | S | 0..* | Extension(Reference(ZD Practitioner)) | Element Id
Composition.extension:actingpractitioner Represents the acting sender of the document Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. Extension(Reference(ZD Practitioner)) Extension URLhttp://zorgdomein.nl/fhir/StructureDefinition/zd-actingpractitioner Constraints
|
sender | 1..1 | Extension(Reference(ZD PractitionerRole)) | Element Id
Composition.extension:sender Represents the responsible sender of the document Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. Extension(Reference(ZD PractitionerRole)) Extension URLhttp://zorgdomein.nl/fhir/StructureDefinition/zd-sender Constraints
|
|
url | 1..1 | uriFixed Value |
There are no (further) constraints on this element Element Id
Composition.extension:sender.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
http://zorgdomein.nl/fhir/StructureDefinition/zd-sender
|
|
valueReference | 1..1 | Reference(ZD PractitionerRole) |
There are no (further) constraints on this element Element Id
Composition.extension:sender.value[x]:valueReference Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded Reference(ZD PractitionerRole) Constraints
|
|
recipient | 1..1 | Extension(Reference(ZD PractitionerRole)) | Element Id
Composition.extension:recipient Intended recipient of this document. This can be both a Practitioner as well as an Organization Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. Extension(Reference(ZD PractitionerRole)) Extension URLhttp://zorgdomein.nl/fhir/StructureDefinition/zd-recipient Constraints
|
|
pdfDocument | 0..1 | Extension(Reference(ZD DocumentReference)) | Element Id
Composition.extension:pdfDocument Base64 Encoded PDF-version of document Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. Extension(Reference(ZD DocumentReference)) Extension URLhttp://zorgdomein.nl/fhir/StructureDefinition/zd-pdfDocument Constraints
|
|
destination | 1..1 | Extension(Reference(ZD PractitionerRole)) | Element Id
Composition.extension:destination Practitioner or organization this documents needs to be delivered to Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. Extension(Reference(ZD PractitionerRole)) Extension URLhttp://zorgdomein.nl/fhir/StructureDefinition/zd-destination Constraints
|
|
url | 1..1 | uriFixed Value |
There are no (further) constraints on this element Element Id
Composition.extension:destination.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
http://zorgdomein.nl/fhir/StructureDefinition/zd-destination
|
|
valueReference | 1..1 | Reference(ZD PractitionerRole) |
There are no (further) constraints on this element Element Id
Composition.extension:destination.value[x]:valueReference Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded Reference(ZD PractitionerRole) Constraints
|
|
identifier | S Σ | 1..1 | Identifier |
There are no (further) constraints on this element Element Id
Composition.identifier Logical identifier of composition (version-independent) DefinitionLogical identifier for the composition, assigned when created. This identifier stays constant as the composition is changed over time. See discussion in resource definition for how these relate.
|
use | Σ ?! | 0..1 | codeBinding |
There are no (further) constraints on this element Element Id
Composition.identifier.use usual | official | temp | secondary (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
|
type | Σ | 0..1 | CodeableConceptBinding |
There are no (further) constraints on this element Element Id
Composition.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Identifier Type Codes (extensible) Constraints
|
system | S Σ | 1..1 | uriFixed Value | Element Id
Composition.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://zorgdomein.nl/zdnumber/
|
value | Σ | 1..1 | string | Element Id
Composition.identifier.value The ZD Number corresponding to this document DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.
General
123456 Mappings
|
period | Σ | 0..1 | Period |
There are no (further) constraints on this element Element Id
Composition.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. 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"). If duration is required, specify the type as Interval|Duration.
|
assigner | Σ | 0..1 | Reference(Organization) |
There are no (further) constraints on this element Element Id
Composition.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
status | S Σ ?! | 1..1 | codeBindingFixed Value | Element Id
Composition.status preliminary | final | amended | entered-in-error DefinitionThe workflow/clinical status of this composition. The status is a marker for the clinical standing of the document. Need to be able to mark interim, amended, or withdrawn compositions or documents. If a composition is marked as withdrawn, the compositions/documents in the series, or data from the composition or document series, should never be displayed to a user without being clearly marked as untrustworthy. The flag "entered-in-error" is why this element is labeled as a modifier of other elements. Some reporting work flows require that the original narrative of a final document never be altered; instead, only new narrative can be added. The composition resource has no explicit status for explicitly noting whether this business rule is in effect. This would be handled by an extension if required.
final
|
type | S Σ | 1..1 | CodeableConceptBinding | Element Id
Composition.type Document sub type DefinitionSpecifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition. Key metadata element describing the composition, used in searching/filtering. For Composition type, LOINC is ubiquitous and strongly endorsed by HL7. Most implementation guides will require a specific LOINC code, or use LOINC as an extensible binding. FHIR Document Type Codes (preferred) Constraints
|
class | S Σ | 1..1 | CodeableConcept | Element Id
Composition.class Document type DefinitionA categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type. Helps humans to assess whether the composition is of interest when viewing an index of compositions or documents. This is a metadata field from XDS/MHD. FHIR Document Class Codes (example) Constraints
|
subject | S Σ | 1..1 | Reference(ZD Patient) | Element Id
Composition.subject Represents the patient that is the document's subject DefinitionWho or what the composition is about. The composition 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 livestock, or a set of patients that share a common exposure). Essential metadata for searching for the composition. Identifies who and/or what the composition/document is about. For clinical documents, this is usually the patient.
|
encounter | Σ | 0..1 | Reference(Encounter) |
There are no (further) constraints on this element Element Id
Composition.encounter Context of the Composition DefinitionDescribes the clinical encounter or type of care this documentation is associated with. Provides context for the composition and supports searching. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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.
|
date | Σ | 1..1 | dateTime |
There are no (further) constraints on this element Element Id
Composition.date Composition editing time DefinitionThe composition editing time, when the composition was last logically changed by the author. dateTime is used for tracking, organizing versions and searching. The Last Modified Date on the composition may be after the date of the document was attested without being changed.
|
author | S Σ | 1..* | Reference(ZD Practitioner) | Element Id
Composition.author Represents the actual responsible sender DefinitionIdentifies who is responsible for the information in the composition, not necessarily who typed it in. Identifies who is responsible for the content. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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.
|
title | Σ | 1..1 | string |
There are no (further) constraints on this element Element Id
Composition.title Human Readable name/title DefinitionOfficial human-readable label for the composition. For many compositions, the title is the same as the text or a display name of Composition.type (e.g. a "consultation" or "progress note"). Note that CDA does not make title mandatory, but there are no known cases where it is useful for title to be omitted, so it is mandatory here. Feedback on this requirement is welcome during the trial use period.
|
confidentiality | Σ ?! | 0..1 | codeBinding |
There are no (further) constraints on this element Element Id
Composition.confidentiality As defined by affinity domain DefinitionThe code specifying the level of confidentiality of the Composition. The exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for the base specification, and delegated to implementation profiles (see security section). This element is labeled as a modifier because highly confidential documents must not be treated as if they are not. ConfidentialityClassification (required) Constraints
|
attester | Σ | 0..* | BackboneElement |
There are no (further) constraints on this element Element Id
Composition.attester Attests to accuracy of composition DefinitionA participant who has attested to the accuracy of the composition/document. Identifies responsibility for the accuracy of the composition content. Only list each attester once.
|
mode | Σ | 1..* | codeBinding |
There are no (further) constraints on this element Element Id
Composition.attester.mode personal | professional | legal | official DefinitionThe type of attestation the authenticator offers. Indicates the level of authority of the attestation. Use more than one code where a single attester has more than one mode (professional and legal are often paired). CompositionAttestationMode (required) Constraints
|
time | Σ | 0..1 | dateTime |
There are no (further) constraints on this element Element Id
Composition.attester.time When the composition was attested DefinitionWhen the composition was attested by the party. Identifies when the information in the composition was deemed accurate. (Things may have changed since then.).
|
party | Σ | 0..1 | Reference(Patient | Practitioner | Organization) |
There are no (further) constraints on this element Element Id
Composition.attester.party Who attested the composition DefinitionWho attested the composition in the specified way. Identifies who has taken on the responsibility for accuracy of the composition content. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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. Reference(Patient | Practitioner | Organization) Constraints
|
custodian | Σ | 0..1 | Reference(Organization) |
There are no (further) constraints on this element Element Id
Composition.custodian Organization which maintains the composition DefinitionIdentifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information. Identifies where to go to find the current version, where to report issues, etc. This is useful when documents are derived from a composition - provides guidance for how to get the latest version of the document. This is optional because this is sometimes not known by the authoring system, and can be inferred by context. However, it is important that this information be known when working with a derived document, so providing a custodian is encouraged.
|
relatesTo | Σ | 0..* | BackboneElement |
There are no (further) constraints on this element Element Id
Composition.relatesTo Relationships to other compositions/documents DefinitionRelationships that this composition has with other compositions or documents that already exist. A document is a version specific composition.
|
code | Σ | 1..1 | codeBinding |
There are no (further) constraints on this element Element Id
Composition.relatesTo.code replaces | transforms | signs | appends DefinitionThe type of relationship that this composition has with anther composition or document. If this document appends another document, then the document cannot be fully understood without also accessing the referenced document. DocumentRelationshipType (required) Constraints
|
target[x] | Σ | 1..1 |
There are no (further) constraints on this element Element Id
Composition.relatesTo.target[x] Target of the relationship DefinitionThe target composition/document of this relationship.
|
|
targetIdentifier | Identifier |
There are no (further) constraints on this element Data Type
|
||
targetReference | Reference(Composition) |
There are no (further) constraints on this element Data Type
|
||
event | Σ | 0..* | BackboneElement |
There are no (further) constraints on this element Element Id
Composition.event The clinical service(s) being documented DefinitionThe clinical service, such as a colonoscopy or an appendectomy, being documented. Provides context for the composition and creates a linkage between a resource describing an event and the composition created describing the event. The event needs to be consistent with the type element, though can provide further information if desired.
|
code | Σ | 0..* | CodeableConcept |
There are no (further) constraints on this element Element Id
Composition.event.code Code(s) that apply to the event being documented DefinitionThis 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 typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act. An event can further specialize the act inherent in the typeCode, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more eventCodes are included, they SHALL NOT conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as key words for certain types of queries. v3 Code System ActCode (example) Constraints
|
period | Σ | 0..1 | Period |
There are no (further) constraints on this element Element Id
Composition.event.period The period covered by the documentation DefinitionThe period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. 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"). If duration is required, specify the type as Interval|Duration.
|
detail | Σ | 0..* | Reference(Resource) |
There are no (further) constraints on this element Element Id
Composition.event.detail The event(s) being documented DefinitionThe description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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.
|
section | 0..* | BackboneElement | Element Id
Composition.section Composition is broken into sections DefinitionThe root of the sections that make up the composition. Unordered, Open, by code.coding.code(Value) Constraints
|
|
(All Slices) |
There are no (further) constraints on this element
|
|||
title | 0..1 | string |
There are no (further) constraints on this element Element Id
Composition.section.title Label for section (e.g. for ToC) Alternate namesheader, label, caption DefinitionThe label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents. Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
|
|
code | 0..1 | CodeableConcept |
There are no (further) constraints on this element Element Id
Composition.section.code Classification of section (recommended) DefinitionA code identifying the kind of content contained within the section. This must be consistent with the section title. Provides computable standardized labels to topics within the document. The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code. Document Section Codes (example) Constraints
|
|
text | 0..1 | Narrative |
There are no (further) constraints on this element Element Id
Composition.section.text Text summary of the section, for human interpretation DefinitionA human-readable narrative that contains the attested content of the section, 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. Document profiles may define what content should be represented in the narrative to ensure clinical safety.
|
|
mode | Σ ?! | 0..1 | codeBinding |
There are no (further) constraints on this element Element Id
Composition.section.mode working | snapshot | changes DefinitionHow the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. This element is labeled as a modifier because a change list must not be mis-understood as a complete list.
|
orderedBy | 0..1 | CodeableConceptBinding |
There are no (further) constraints on this element Element Id
Composition.section.orderedBy Order of section entries DefinitionSpecifies the order applied to the items in the section entries. Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.
|
|
entry | 0..* | Reference(Resource) |
There are no (further) constraints on this element Element Id
Composition.section.entry A reference to data that supports this section DefinitionA reference to the actual resource from which the narrative in the section is derived. If there are no entries in the list, an emptyReason SHOULD be provided.
|
|
emptyReason | 0..1 | CodeableConceptBinding |
There are no (further) constraints on this element Element Id
Composition.section.emptyReason Why the section is empty DefinitionIf the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. Allows capturing things like "none exist" or "not asked" which can be important for most lists. The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases. List Empty Reasons (preferred) Constraints
|
|
section | 0..* | see (section) |
There are no (further) constraints on this element Element Id
Composition.section.section Nested Section DefinitionA nested sub-section within this section. Nested sections are primarily used to help human readers navigate to particular portions of the document.
|
|
insuranceDetails | 0..* | BackboneElement | Element Id
Composition.section:insuranceDetails Section contains insurance details DefinitionThe root of the sections that make up the composition.
|
|
title | 0..1 | string |
There are no (further) constraints on this element Element Id
Composition.section:insuranceDetails.title Label for section (e.g. for ToC) Alternate namesheader, label, caption DefinitionThe label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents. Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
|
|
code | 0..1 | CodeableConcept |
There are no (further) constraints on this element Element Id
Composition.section:insuranceDetails.code Classification of section (recommended) DefinitionA code identifying the kind of content contained within the section. This must be consistent with the section title. Provides computable standardized labels to topics within the document. The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code. Document Section Codes (example) Constraints
|
|
coding | Σ | 0..* | Coding |
There are no (further) constraints on this element Element Id
Composition.section:insuranceDetails.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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.
|
system | Σ | 0..1 | uriFixed Value | Element Id
Composition.section:insuranceDetails.code.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 de-reference to some definition that establish the system clearly and unambiguously.
http://zorgdomein.nl/terminology/code-system/envelope-element
|
version | Σ | 0..1 | string |
There are no (further) constraints on this element Element Id
Composition.section:insuranceDetails.code.coding.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | Σ | 0..1 | codeFixed Value | Element Id
Composition.section:insuranceDetails.code.coding.code Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size
insurance-details
|
display | Σ | 0..1 | string |
There are no (further) constraints on this element Element Id
Composition.section:insuranceDetails.code.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean |
There are no (further) constraints on this element Element Id
Composition.section:insuranceDetails.code.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). 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. 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.
|
text | Σ | 0..1 | string |
There are no (further) constraints on this element Element Id
Composition.section:insuranceDetails.code.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
|
text | 0..1 | Narrative |
There are no (further) constraints on this element Element Id
Composition.section:insuranceDetails.text Text summary of the section, for human interpretation DefinitionA human-readable narrative that contains the attested content of the section, 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. Document profiles may define what content should be represented in the narrative to ensure clinical safety.
|
|
mode | Σ ?! | 0..1 | codeBinding |
There are no (further) constraints on this element Element Id
Composition.section:insuranceDetails.mode working | snapshot | changes DefinitionHow the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. This element is labeled as a modifier because a change list must not be mis-understood as a complete list.
|
orderedBy | 0..1 | CodeableConceptBinding |
There are no (further) constraints on this element Element Id
Composition.section:insuranceDetails.orderedBy Order of section entries DefinitionSpecifies the order applied to the items in the section entries. Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.
|
|
entry | 0..* | Reference(Resource) |
There are no (further) constraints on this element Element Id
Composition.section:insuranceDetails.entry A reference to data that supports this section DefinitionA reference to the actual resource from which the narrative in the section is derived. If there are no entries in the list, an emptyReason SHOULD be provided.
|
|
emptyReason | 0..1 | CodeableConceptBinding |
There are no (further) constraints on this element Element Id
Composition.section:insuranceDetails.emptyReason Why the section is empty DefinitionIf the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. Allows capturing things like "none exist" or "not asked" which can be important for most lists. The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases. List Empty Reasons (preferred) Constraints
|
|
section | 0..* | see (section) |
There are no (further) constraints on this element Element Id
Composition.section:insuranceDetails.section Nested Section DefinitionA nested sub-section within this section. Nested sections are primarily used to help human readers navigate to particular portions of the document.
|
|
requestDetails | 0..* | BackboneElement | Element Id
Composition.section:requestDetails Section contains request details DefinitionThe root of the sections that make up the composition.
|
|
title | 0..1 | string |
There are no (further) constraints on this element Element Id
Composition.section:requestDetails.title Label for section (e.g. for ToC) Alternate namesheader, label, caption DefinitionThe label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents. Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
|
|
code | 0..1 | CodeableConcept |
There are no (further) constraints on this element Element Id
Composition.section:requestDetails.code Classification of section (recommended) DefinitionA code identifying the kind of content contained within the section. This must be consistent with the section title. Provides computable standardized labels to topics within the document. The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code. Document Section Codes (example) Constraints
|
|
coding | Σ | 0..* | Coding |
There are no (further) constraints on this element Element Id
Composition.section:requestDetails.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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.
|
system | Σ | 0..1 | uriFixed Value | Element Id
Composition.section:requestDetails.code.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 de-reference to some definition that establish the system clearly and unambiguously.
http://zorgdomein.nl/terminology/code-system/envelope-element
|
version | Σ | 0..1 | string |
There are no (further) constraints on this element Element Id
Composition.section:requestDetails.code.coding.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | Σ | 0..1 | codeFixed Value | Element Id
Composition.section:requestDetails.code.coding.code Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size
request-details
|
display | Σ | 0..1 | string |
There are no (further) constraints on this element Element Id
Composition.section:requestDetails.code.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean |
There are no (further) constraints on this element Element Id
Composition.section:requestDetails.code.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). 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. 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.
|
text | Σ | 0..1 | string |
There are no (further) constraints on this element Element Id
Composition.section:requestDetails.code.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
|
text | 0..1 | Narrative |
There are no (further) constraints on this element Element Id
Composition.section:requestDetails.text Text summary of the section, for human interpretation DefinitionA human-readable narrative that contains the attested content of the section, 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. Document profiles may define what content should be represented in the narrative to ensure clinical safety.
|
|
mode | Σ ?! | 0..1 | codeBinding |
There are no (further) constraints on this element Element Id
Composition.section:requestDetails.mode working | snapshot | changes DefinitionHow the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. This element is labeled as a modifier because a change list must not be mis-understood as a complete list.
|
orderedBy | 0..1 | CodeableConceptBinding |
There are no (further) constraints on this element Element Id
Composition.section:requestDetails.orderedBy Order of section entries DefinitionSpecifies the order applied to the items in the section entries. Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.
|
|
entry | 0..* | Reference(Resource) |
There are no (further) constraints on this element Element Id
Composition.section:requestDetails.entry A reference to data that supports this section DefinitionA reference to the actual resource from which the narrative in the section is derived. If there are no entries in the list, an emptyReason SHOULD be provided.
|
|
emptyReason | 0..1 | CodeableConceptBinding |
There are no (further) constraints on this element Element Id
Composition.section:requestDetails.emptyReason Why the section is empty DefinitionIf the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. Allows capturing things like "none exist" or "not asked" which can be important for most lists. The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases. List Empty Reasons (preferred) Constraints
|
|
section | 0..* | see (section) |
There are no (further) constraints on this element Element Id
Composition.section:requestDetails.section Nested Section DefinitionA nested sub-section within this section. Nested sections are primarily used to help human readers navigate to particular portions of the document.
|
See the profile on simplifier.net for additional details.