2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Profile XDS profile for Document Reference - Definitions

Todo

Definitions for the xds-documentmanifest Profile.

DocumentManifest(DocumentManifest)
Definition

A manifest that defines a set of documents.

Control1..1
Requirements
Comments
DocumentManifest.id
Definition

The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.

Control0..1
Typeid
Requirements
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.

DocumentManifest.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
Requirements
Comments
DocumentManifest.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.

Control0..1
Typeuri
Is Modifiertrue
Requirements
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 as much as possible.

DocumentManifest.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language
The codes SHALL be taken from http://tools.ietf.org/html/bcp47
Typecode
Requirements
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).

DocumentManifest.text
Definition

A human-readable narrative that contains a summary of the resource, and may 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.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Requirements
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

DocumentManifest.contained
Definition

These 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.

Control0..*
TypeResource
Requirements
Alternate Namesinline 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.

DocumentManifest.extension
Definition

May 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, 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.

DocumentManifest.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. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, 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.

DocumentManifest.masterIdentifier
Definition

A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.

Control0..1
TypeIdentifier
Requirements
Comments
DocumentManifest.identifier
Definition

A globally unique identifier for the SubmissionSet assigned by the creating entity.

Control1..1
TypeIdentifier
Requirements
Comments

Other identifiers can also include Identifiers may be Accession Numbers, Order Numbers, Referral Request Identifiers, XDS Workflow Instance Identifiers.

DocumentManifest.subject
Definition

the subject of care whose longitudinal record is being reflected in this SubmissionSet.

Control1..*
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Patient))
Requirements
Comments
DocumentManifest.recipient
Definition

The organization(s) or person(s) for whom the SubmissionSet is intended.

Control0..*
TypeChoice of: Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Patient)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Practitioner)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Organization))
Requirements
Comments

How the recipient receives the document set or is notified of it is up to the implementation. This element is just a statement of intent.

DocumentManifest.type
Definition

The code specifying the type of clinical activity that resulted in placing the documents in this SubmissionSet.

Control0..1
BindingSpecifies the kind of a set of documents (e.g. Patient Summary, Discharge Summary, Prescription, etc.). The type of a set of documents may be the same as one of the documents in the set - especially if there is only one - but it may be wider
The codes SHOULD be taken from FHIR Document Codes; other codes may be used where these codes are not suitable
TypeCodeableConcept
Requirements
Comments
DocumentManifest.author
Definition

The humans and/or machines that authored the document in the SubmissionSet. This attribute contains the sub-attributes: authorInstitution, authorPerson, authorRole, authorSpecialty.

Control1..*
TypeChoice of: Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Practitioner)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Device))
Requirements
Comments

Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant).

DocumentManifest.created
Definition

Point in time at the creating entity when the SubmissionSet was created.

Control0..1
TypedateTime
Requirements
Comments

Creation time is used for tracking, organizing versions and searching. This is the creation time of the document set, not the documents on which it is based.

DocumentManifest.source
Definition

OID identifying the instance of the creating entity that contributed the SubmissionSet.

Control0..1
Typeuri
Requirements
Comments
DocumentManifest.status
Definition

The lifecycle status of the SubmissionSet.

Control1..1
BindingThe status of the document reference
The codes SHALL be taken from DocumentReferenceStatus
Typecode
Is Modifiertrue
Requirements
Comments
DocumentManifest.supercedes
Definition

If this document manifest replaces another.

Control0..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/DocumentManifest))
Is Modifiertrue
Requirements
Comments
DocumentManifest.description
Definition

Human-readable description of the source document. This is sometimes known as the "title".

Control0..1
Typestring
Requirements

Helps humans to assess whether the document is of interest.

Comments

What the document is about, rather than a terse summary of the document. It is commonly the case that records do not have a title and are collectively referred to by the display name of Record code (e.g. a "consultation" or "progress note").

DocumentManifest.confidentiality
Definition

A code specifying the level of confidentiality of this set of Documents.

Control0..0
BindingCodes specifying the level of confidentiality of the composition
The codes SHOULD be taken from v3 Code System Confidentiality; other codes may be used where these codes are not suitable
TypeCodeableConcept
Is Modifiertrue
Requirements
Comments

The document set is at least as confidential as the most confidential of the documents in it.

DocumentManifest.content
Definition

The list of resources that describe the parts of this document reference. Usually, these would be document references, but direct references to binary attachments and images are also allowed.

Control1..*
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/DocumentReference))
Requirements
Comments