FHIR-XDS-terminology: Difference between revisions

From IHE Wiki
Jump to navigation Jump to search
BillM (talk | contribs)
BillM (talk | contribs)
Line 13: Line 13:


== Metadata ==
== Metadata ==
Properties about a Resource that describes some aspects of how the Resource behaves.  [http://www.hl7.org/implement/standards/fhir/resources.html#metadata Metadata Properties] are coded outside the Resource.
Properties about a Resource that describes some aspects of how the Resource behaves.  [http://www.hl7.org/implement/standards/fhir/resources.html#metadata Metadata Properties] are coded outside the Resource. In REST they are carried as HTTP headers and in ATOM they are carried as details coded in the Entry but outside the Resource.


In XDS, metadata is a collection of properties about a document.  In FHIR metadata describes Resources (which from an XDS perspective are metadata).
In XDS, metadata is a collection of properties about a document.  In FHIR metadata describes Resources (which from an XDS perspective are metadata).

Revision as of 02:13, 8 April 2014

This page is a repository for terminology issues. Many XDS developers will be confused by FHIR's use of terminology. Between XDS and FHIR there is overlapping terminology but the terms have different meanings. In other cases a newer technology/standard is used instead of the ones chosen for XDS and we describe how the choices relate.

Document

In FHIR a document is a structured/organized collection of resources. A document can be submitted. When received at the server it can be saved as a document OR broken apart into individual resources. This is a decision of the server. If the server keeps the document as a single entity then it can be retrieved as a single object (will have a permanent URI assigned). If the server saved it as individual resources then the individual resources can be retrieved individually (they will each have a permanent URI).

To fully appreciate this semantic you must realize that HL7 anticipates that FHIR will eventually replace V2, V3, and CDA. Maintaining a document as a single entity would mimic the behavior of the current CDA specification with one very large expansion of capability. Individual parts of a document can be web addressable (have their own URI). Again, a choice of the receiving server.

DocumentManifest

The FHIR equivalent to SubmissionSet.

DocumentReference

The FHIR equivalent to DocumentEntry.

Metadata

Properties about a Resource that describes some aspects of how the Resource behaves. Metadata Properties are coded outside the Resource. In REST they are carried as HTTP headers and in ATOM they are carried as details coded in the Entry but outside the Resource.

In XDS, metadata is a collection of properties about a document. In FHIR metadata describes Resources (which from an XDS perspective are metadata).

Resource

The fundamental building block in FHIR is the resource. Two in particular are of interest to XDS, DocumentReference and DocumentManifest. DocumentReference maps to DocumentEntry and DocumentManifest maps to SubmissionSet. There is no FHIR equivalent to Folder.