6.4 DocumentReference リソース
Home ＞ Infrastructure ＞ DocumentReference [documentreference]
Resource DocumentReference - Content6.4
A reference to a document.
The resource name as it appears in a RESTful URL is [root]/documentreference/
A document reference resource is used to describe a document that is made available to a healthcare system. A document is some sequence of bytes that is identifiable, establishes it's own context (e.g. what subject, author etc), can be displayed to the user, and has defined update management. The document resource can be used with any document format that has a recognised mime type, and that conforms to this definition.
Typically, Document Reference Resources are used in document indexing systems, such as IHE XDS (see the XDS specific profile), and are used to refer to:
- CDA documents in FHIR systems
- FHIR documents stored elsewhere (i.e. registry/repository following the XDS model)
- PDF documents, and even digital records of faxes where sufficient information is available
- Other kinds of documents, such as records of prescriptions.
FHIR defines both a document format and this document reference. FHIR documents are for documents that are authored and assembled in FHIR. This resource is mainly intended for general references to other documents.
The document that is a target of the reference can be a reference to a FHIR document served by another server, or the target can be stored in the special FHIR Binary Resource, or the target can be stored on some other server system. The document reference is also able to address documents that are retrieved by a service call such as an XDS.b RetrieveDocumentSet, or a DICOM exchange, or a v2 message query, though the way each of these service calls works must be specified in some external stanard or other documentation.
Resource Content 6.4.1
<DocumentReference xmlns="http://hl7.org/fhir"> <!-- from Resource: extension, narrative, and contained --> <masterIdentifier><!-- 1..1 Identifier Master Version Specific Identifier --></masterIdentifier> <identifier><!-- 0..* Identifier Other identifiers for the document --></identifier> <subject><!-- 1..1 Resource(Patient|Practitioner|Group|Device) The subject of the document --></subject> <type><!-- 1..1 CodeableConcept What kind of document this is (LOINC if possible) --></type> <subtype><!-- 0..1 CodeableConcept More detail about the document type --></subtype> <author><!-- 1..* Resource(Practitioner|Device) Who/what authored the document --></author> <custodian><!-- 0..1 Resource(Organization) Org which maintains the document --></custodian> <authenticator><!-- 0..1 Resource(Practitioner|Organization) Who authenticated the document --></authenticator> <created value="[dateTime]"/><!-- 0..1 Document creation time --> <indexed value="[instant]"/><!-- 1..1 When this document reference created --> <status value="[code]"/><!-- 1..1 current | superseded | error --> <docStatus><!-- 0..1 CodeableConcept Status of the underlying document --></docStatus> <supercedes><!-- 0..1 Resource(DocumentReference) If this document replaces another --></supercedes> <description value="[string]"/><!-- 0..1 Human Readable description (title) --> <confidentiality><!-- 0..1 CodeableConcept Sensitivity of source document --></confidentiality> <primaryLanguage value="[code]"/><!-- 0..1 Primary language of the document --> <mimeType value="[code]"/><!-- 1..1 Mime type of the document --> <format><!-- 0..1 CodeableConcept Format of the document --></format> <size value="[integer]"/><!-- 0..1 Size of the document in bytes --> <hash value="[string]"/><!-- 0..1 HexBinary representation of SHA1 --> <location value="[uri]"/><!-- 0..1 Where to access the document --> <service> <!-- 0..1 If access is not fully described by location --> <type><!-- 1..1 CodeableConcept Type of service (i.e. XDS.b) --></type> <address value="[string]"/><!-- 0..1 Where service is located (usually a URL) --> <parameter> <!-- 0..* Service call parameters --> <name value="[string]"/><!-- 1..1 Name of parameter --> <value value="[string]"/><!-- 0..1 Parameter value --> </parameter> </service> <context> <!-- 0..1 Clinical context of document --> <code><!-- 0..* CodeableConcept Type of context (i.e. type of event) --></code> <period><!-- 0..1 Period Time described by the document --></period> <facilityType><!-- 0..1 CodeableConcept Kind of facility where patient was seen --></facilityType> </context> </DocumentReference>
Alternate definitions: Schema/Schematron, Resource Profile
Terminology Bindings 6.4.1.1
Constraints6.4.1.2
- Inv-1: A location or a service (or both) must be provided (xpath: exists(f:location) or exists(f:service))
Search Parameters 6.4.2
Search Parameters for RESTful searches. The standard parameters also apply. See Searching for more information.