This wiki has undergone a migration to Confluence found Here

Order interaction for the creation of a document

From HL7Wiki
Jump to navigation Jump to search


This proposal documents a new set of HL7 version 3 interactions related to 'ordering the creation of a document'. The document could be of any mime-type, and could have a structured or a non-structured content. The focus will be on structured CDA (and more general: SDA) documents, but this should not preclude the interactions from being used for other documents.

The newly created set of interactions should be part of the composite order (POOR) domain.


  • Sending an order to request for the (human) creation of a clinical summary report; sending an order to request the creation (by a software application) of a lab result report.

Dutch Storyboards

  • (use case 1) Gerald General, a GP is informed (exactly how is out of scope of this simplified use-case description) that Patient Eve Everywoman has had an encounter with Radiologist Dr. Röntgen and Gynaecologist Dr. Gerard, both in the same hospital. Given that the GP has a responsibility in the provision of continuous care to the patient he sends an order for a 'consultant summary' to Dr. Röntgen, and another order for a 'consultant summary document' to Dr. Gerard. Dr. General stores the documents (and the information contained therein) in his GP system. When Eve shows up for a future GP consultation Dr. General has access to the data generated during the hospital encounter.
  • (use case 2, minor variation) Irvin Internist, a specialist in the area of internal medicine, is informed (exactly how is out of scope of this simplified use-case description) that Patient Eve Everywoman has had a prior encounter with another Internist Dr. Iznogood in a different hospital. Dr. Internist sends an order for a 'consultant summary document' to Dr. Iznogood. Dr. Internist stores the document (and the information contained therein) in his software application. When Eve shows up for a future encounter with Dr. Internist he has access to the data generated during the prior encounter.

Canadian Storyboards

  • Eve Everywoman has been referred by Dr. Beaker to another provider (Dr Oncologist) for a consult. While Dr. Beaker has received a paper copy of a specific lab result from the lab. Dr. Beaker needs an 'legally authenticated', electronic 'document' to communicate to the consulting provider. Dr. Breaker 'orders a document' for the lab result from the lab.
In CDA terms, the response CDA document is has to contain a legalAuthenticator participation.

New Zealand Storyboards

  • Mrs V Ursula N Hapi, for a variety of reasons, has finally decided that she can no longer continue to visit her usual GP, Dr I S Deaf. However, she is unable to summon up the courage to approach practice nurse, Nurse I Fiona U Dare, to request that her records be transferred to a new GP who seems far more disposed to address her ailments, Dr E M Pathetic. This use case describes the ability of Dr Pathetic's Practice Management System (PMS) to request that all records relevant to Mrs Hapi's prior primary healthcare at the rooms of Dr Deaf be transferred to it in the form of a collection of document(s). The collection of documents includes an overarching summary document with associated supporting documents, notably scanned versions of letters received by Dr Deaf.

IHE Use-cases

  • The Deferred Document and Dynamically Created Content profile (D3S) (a draft 2010 proposal to extend the XDS set of profiles available in ITI TF) document the use-case whereby the Dynamic Document Source actor has the capability to create an on-the-fly document if and only if the document is queried for (i.e. in HL7 terms: when ordered to create) the document.
    • The request always returns the most current content available to the responder. The use of dynamically created content is intended for an application architecture where the supplier of data wishes to provide, through a single request mechanism, the most current information available at the time of request. The dynamic nature of the data means this environment is more complicated to support bu allows easy access to, for instance, summary data for a specific patient. However, it does not provide for robust source attestation of the overall document content because the content is selected by a computer algorithm rather than overseen and attested in whole by a clinician.
    • The request parameters are limited to the available metadata fields in the XDS registry. These include: patientId, document type, type of clinical event being documented, time interval of the clinical event, language, author, author's organization, legal authenticator, mime type, document relationship.

Dynamic Model

In terms of Dynamic Model and Trigger Events the newly proposed Topic conforms to the general Orders and Requests Pattern as defined by the Orders and Observations WG. That design pattern will be used as the basis for this topic.


  1. why an order, why not a query? A query requests that an existing document be sent to the querying party - the result of which may be 'there are no documents that match your query parameters'. In order requests the execution of a workflow: the creation of a new document.
  2. Charlie McCay: This is very like the usecase being addressed by ISO/CEN 13606:5 - is there any chance of this being a combined effort?

Static Model

The static model used in the order interactions has to indicate various items of metadata related to the document that should be created (e.g. requested document type, requested author, requested templates the document should conform to, patient id, etc.).

Note: some of the act relationships used may (still) point in the wrong direction. The model should suffice to get an idea of what it would take to satisfy the use-cases documented above.

Ordering creation cda.png

Model walkthough

The focal act is the ClinicalDocumentRequest act. This act contains the details of the request activity.

  • id: the identification of the request activity.
  • code: the type of document that is being requested. Usually a code from the LOINC coding system.
  • effectiveTime: (standard wording)
  • priorityCode: (standard wording)
  • confidentialiltyCode: (standard wording)

The participations on the left-hand side of the model are copied from the POOR domain. See POOR for documentation.

The instantiation association and the ClinicalDocumentDefinition class can be used to identify characteristics of the requested document. The ClinicalDocumentDefinition class has the follwoing attributes:

  • id: the identification of definition of a document structure, i.e. a document-level templateID. Example: the OID of CCD, or the OID of IHE Laboratory Report, or the OID for German Discharge Letter.
  • text: the mime-type of the requested document, e.g. the mime-type for CDA, or PDF. Note that the use of this attribute is constraint to conveying the mime-type. The value of this attribute SHALL not be in conflict with any requirements as defined in the template identified by the id attribute (if present).
  • languageCode: the language of the requested document, e.g. French. The value of this attribute SHALL not be in conflict with any requirements as defined in the template identified by the id attribute (if present).

The subject association and the ServiceEvent class are used to identify the activities which should be documented in (be the subject of the) requested document. The ServiceEvent class could be a procedure, an observation, or an encounter. ServiceEvent has the following attributes:

  • id: identification of the event that should be documented
  • code: type of activity that should be documented
    • If code is the only attribute that has a value, one can support the use-case whereby one requests that "all encounters be documented", or "all laboratory tests".
  • effectiveTime: any activities within this time interval are requested to be documented
    • If effectiveTime is used in combination with the code attribute one can support the use-case of requesting documentation of "all encounters that took place last year".

The targetOf association and the ActIntent class are used to support the use-case whereby a document should only be created after the completion of a request. Example: a request to create a laboratory result document should be performed after the laboratory order has been completed (i.e. when the final results are available). ActIntent has the following attributes:

  • id: the identification of a request (placer order number) or a promise activity (filler order number)

The inFullmentOf association (and the ServiceEvent/ActIntent classes) is used to support the use-case where the party that requests certain activities to be documented doesn't have the identifier of those activities, but it does know the identifier of the order that lead to the activities. Example: if one first requests a laboratory test to be done (with placer ID 123), and one subsequently requests that a document be created for all lab results associated with the lab order 123. In this case the attributes in the ServiceEvent class won't be valued, and shall be valued with 123.


OPEN ISSUE: the subject patient. If the document requests that "all encounters for patient X" be documented, there are two options:

  1. The POOR model already has a subject participation to a R_Subject CMET. This is a participation with the "requested documentation activity".
  2. We may need to add a subject participation to the ServiceEvent act.

For other (older parts) of the discussion, as well as a record from discussions during WGMs, see the associated Talk page.