FQL is a query language that allows you to retrieve, filter and project data from any data source containing FHIR Resources. It brings the power of three existing languages together: SQL, JSON and FhirPath. It allows you to create tables and is useful for gaining insight and perform quality control.
Query
-
Default
What is FQL?
-
FQL Query resources
FQL Playground
Try Firely Query Language in our playground by using this scope as data source.
- FQL Documentation
-
FQL Language
Syntax specification
To learn more about FQL syntax choose this menu item.
-
YamlGen Generate resources
YamlGen Playground
Try YamlGen in our playground by using this scope as data source.
-
YamlGen Language
YamlGen Syntax specification
To learn more about YamlGen syntax choose this.
-
FHIRPath Inspect resource
FHIRPath Playground
Try out the FHIRPath playground and navigate inside this resource.
-
FHIRPath Documentation
FHIRPath Documentation
Find out what FHIRPath is or learn how to write FHIRPath scripts.
API
-
FHIR
Get this resource using a FHIR client.
-
Embed
Embed this resource in your own website. How?
Tools
-
Custom Example generation
Custom Example generation beta
Experiment with resource instance generation using YamlGen and based on this profile.
This feature is in beta. You can help us improve it by giving feedback with the feedback button at the top of the screen.
STF Dateien
Metadaten zu Dateien, die im Kontext der STF Übermittlung relevant sind
- type Profile on DocumentReference
- FHIR R4
- status Draft
-
version...
Missing canonical claim
The canonical from this resource does not match any claims.
Canonical claims are used to verify ownership of your canonical URLs.
Canonical
| StfDatei (DocumentReference) | C | DocumentReference | There are no (further) constraints on this element Element idDocumentReferenceShort description A reference to a document DefinitionA reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text. Usually, this is used for documents other than those defined by FHIR.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idDocumentReference.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idDocumentReference.metaShort description Metadata about the resource DefinitionThe 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.
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idDocumentReference.implicitRulesShort description A set of rules under which this content was created DefinitionA 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. 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 it's narrative along with other profiles, value sets, etc.
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idDocumentReference.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idDocumentReference.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. Contained resources do not have 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.
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idDocumentReference.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. 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.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idDocumentReference.extensionShort description 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. 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 can 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.
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idDocumentReference.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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 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. 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). 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. 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.
| ||
| masterIdentifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idDocumentReference.masterIdentifierShort description Master Version Specific Identifier DefinitionDocument identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document. The structure and format of this Id shall be consistent with the specification corresponding to the formatCode attribute. (e.g. for a DICOM standard document a 64-character numeric UID, for an HL7 CDA format a serialization of the CDA Document Id extension and root in the form "oid^extension", where OID is a 64 digits max, and the Id is a 16 UTF-8 char max. If the OID is coded without the extension then the '^' character shall not be included.). CDA Document Id extension and root.
| ||
| identifier | S Σ | 0..* | Identifier | Element idDocumentReference.identifierShort description Other identifiers for the document DefinitionOther identifiers associated with the document, including version independent identifiers. Beispielsweise Sterbebuch Nummer oder StAmt_Aktenzeichen
| ||
| status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idDocumentReference.statusShort description current | superseded | entered-in-error DefinitionThe status of this document reference. 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. The status of the document reference. DocumentReferenceStatus (required) Constraints
| ||
| docStatus | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idDocumentReference.docStatusShort description preliminary | final | amended | entered-in-error DefinitionThe status of the underlying document. The document that is pointed to might be in various lifecycle states. Status of the underlying document.
| ||
| type | S Σ | 0..1 | CodeableConceptBinding | Element idDocumentReference.typeShort description Kind of document (LOINC if possible) DefinitionSpecifies 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. 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. Precise type of clinical document.
| ||
| category | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idDocumentReference.categoryShort description Categorization of document Alternate namesclaxs DefinitionA 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. 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. High-level kind of a clinical document at a macro level. DocumentClassValueSet (example) Constraints
| ||
| subject | S Σ | 0..1 | Reference(Patient) | Element idDocumentReference.subjectShort description Who/what is the subject of the document DefinitionWho 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).
| ||
| date | S Σ | 0..1 | instant | Element idDocumentReference.dateShort description When this document reference was created Alternate namesindexed DefinitionWhen the document reference was created. Beispielsweise das Datum der Sterbeurkunde
| ||
| author | S Σ | 0..* | Reference(Practitioner | Organization) | Element idDocumentReference.authorShort description Who and/or what authored the document DefinitionIdentifies who is responsible for adding the information to the document. Beispielsweise Verweis auf eine Organization, die Informationen zum Standesamt beinhaltet (Nr. und Name). Im Kontext eines Obduktionsscheins der ausstellende Arzt oder Ärztin Reference(Practitioner | Organization) Constraints
| ||
| authenticator | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | There are no (further) constraints on this element Element idDocumentReference.authenticatorShort description Who/what authenticated the document DefinitionWhich person or organization authenticates that this document is valid. Represents a participant within the author institution who has legally authenticated or attested the document. Legal authentication implies that a document has been signed manually or electronically by the legal Authenticator. Reference(Practitioner | PractitionerRole | Organization) Constraints
| |||
| custodian | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idDocumentReference.custodianShort description Organization which maintains the document DefinitionIdentifies the organization or group who is responsible for ongoing maintenance of and access to the document. 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.
| |||
| relatesTo | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idDocumentReference.relatesToShort description Relationships to other documents DefinitionRelationships that this document has with other document references that already exist. This element is labeled as a modifier because documents that append to other documents are incomplete on their own.
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idDocumentReference.relatesTo.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idDocumentReference.relatesTo.extensionShort description 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 element. 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 can 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.
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idDocumentReference.relatesTo.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 manageable, 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). 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. 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.
| ||
| code | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idDocumentReference.relatesTo.codeShort description replaces | transforms | signs | appends DefinitionThe type of relationship that this document has with anther document. If this document appends another document, then the document cannot be fully understood without also accessing the referenced document. The type of relationship between documents. DocumentRelationshipType (required) Constraints
| ||
| target | Σ | 1..1 | Reference(DocumentReference) | There are no (further) constraints on this element Element idDocumentReference.relatesTo.targetShort description Target of the relationship DefinitionThe target document of this relationship.
| ||
| description | Σ | 0..1 | string | There are no (further) constraints on this element Element idDocumentReference.descriptionShort description Human-readable description DefinitionHuman-readable description of the source document. Helps humans to assess whether the document is of interest. What the document is about, a terse summary of the document.
| ||
| securityLabel | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idDocumentReference.securityLabelShort description Document security-tags DefinitionA set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to. Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended. 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. Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible) Constraints
| ||
| content | Σ | 1..* | BackboneElement | There are no (further) constraints on this element Element idDocumentReference.contentShort description Document referenced DefinitionThe document and format referenced. There may be multiple content element repetitions, each with a different format.
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idDocumentReference.content.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idDocumentReference.content.extensionShort description 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 element. 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 can 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.
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idDocumentReference.content.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 manageable, 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). 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. 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.
| ||
| attachment | Σ | 1..1 | Attachment | There are no (further) constraints on this element Element idDocumentReference.content.attachmentShort description Where to access the document DefinitionThe document or URL of the document along with critical metadata to prove content has integrity.
| ||
| format | Σ | 0..1 | CodingBinding | There are no (further) constraints on this element Element idDocumentReference.content.formatShort description Format/content rules for the document DefinitionAn identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType. Note that while IHE mostly issues URNs for format types, not all documents can be identified by a URI. Document Format Codes. DocumentReferenceFormatCodeSet (preferred) Constraints
| ||
| context | S Σ | 0..1 | BackboneElement | There are no (further) constraints on this element Element idDocumentReference.contextShort description Clinical context of document DefinitionThe clinical context in which the document was prepared. These values are primarily added to help with searching for interesting/relevant documents.
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idDocumentReference.context.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idDocumentReference.context.extensionShort description 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 element. 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 can 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.
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idDocumentReference.context.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 manageable, 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). 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. 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.
| ||
| encounter | 0..* | Reference(Encounter | EpisodeOfCare) | There are no (further) constraints on this element Element idDocumentReference.context.encounterShort description Context of the document content DefinitionDescribes the clinical encounter or type of care that the document content is associated with. Reference(Encounter | EpisodeOfCare) Constraints
| |||
| event | 0..* | CodeableConcept | There are no (further) constraints on this element Element idDocumentReference.context.eventShort description Main clinical acts 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 type Code, 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 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. This list of codes represents the main clinical acts being documented.
| |||
| period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idDocumentReference.context.periodShort description Time of service that is being documented DefinitionThe time period over which the service that is described by the document was provided.
| ||
| facilityType | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idDocumentReference.context.facilityTypeShort description Kind of facility where patient was seen DefinitionThe kind of facility where the patient was seen. XDS Facility Type. FacilityTypeCodeValueSet (example) Constraints
| |||
| practiceSetting | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idDocumentReference.context.practiceSettingShort description Additional details about where the content was created (e.g. clinical specialty) DefinitionThis property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty. This is an important piece of metadata that providers often rely upon to quickly sort and/or filter out to find specific content. 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. Additional details about where the content was created (e.g. clinical specialty). PracticeSettingCodeValueSet (example) Constraints
| |||
| sourcePatientInfo | 0..1 | Reference(Patient) | There are no (further) constraints on this element Element idDocumentReference.context.sourcePatientInfoShort description Patient demographics from source DefinitionThe Patient Information as known when the document was published. May be a reference to a version specific, or contained.
| |||
| related | S | 0..* | Reference(Resource) | Element idDocumentReference.context.relatedShort description Related identifiers or resources DefinitionRelated identifiers or resources associated with the DocumentReference. Im Kontext eines Obduktionsscheins verweis auf eine Observation, welche die Todesursache abbildet
|
Documentation:
https://simplifier.net/sterbefall/stfdatei
Last updated on