This page is part of the FHIR Specification (v0.06: DSTU 1 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Status: XDS resource under consideration by IHE and the FHIR project team. Draft for Comment
An entry in an XDS registry.
The resource name as it appears in a RESTful URL is /xdsentry2/
See the description on the XdsEntry resource
<XdsEntry2 xmlns="http://hl7.org/fhir"> <id><!-- 1..1 Identifier Version Specific Document Identifier (uri or urn) --></id> <information> <!-- 0..1 Searchable Document metadata --> <id><!-- 0..1 Identifier logical identifier for document (version-independent) --></id> <versionId><!-- 0..1 Identifier version-specific identifier for document --></versionId> <instant><!-- 1..1 instant Document Creation Time --></instant> <class><!-- 0..1 Coding particular kind of document --></class> <type><!-- 1..1 CodeableConcept Kind of Document (LOINC if possible) --></type> <title><!-- 0..1 string Document Title --></title> <confidentialityCode><!-- 1..1 Coding as defined by Affinity Domain --></confidentialityCode> <subject><!-- 1..1 Resource(Person|Patient|Group|Device) Who/what the document is about --></subject> <author><!-- 1..* Resource(Person|Agent) Who/what authored the final document --></author> <attester> <!-- 0..* Attests to accuracy of document --> <mode><!-- 1..1 code Personal | professional | legal | official --></mode> <time><!-- 0..1 dateTime When document attested --></time> <party><!-- 0..1 Resource(Person|Agent|Organization) Who attested the document --></party> </attester> <custodian><!-- 0..1 Resource(Organization) Org which maintains the document --></custodian> <event> <!-- 0..1 The clinical event/act/item being documented --> <code><!-- 0..* CodeableConcept code(s) that apply to the event being documented --></code> <period><!-- 0..1 Period The period covered by the document --></period> <detail><!-- 0..* Resource(Any) Full details for the event(s) the document concents --></detail> </event> <encounter><!-- 0..1 Resource(Admission|InterestOfCare) Context of the document --></encounter> <facilityType><!-- 0..1 CodeableConcept type of organizational setting --></facilityType> <practiceSetting><!-- 0..1 CodeableConcept clinical speciality of the act --></practiceSetting> </information> <format><!-- 1..1 Coding format (urn:.. Following rules) --></format> <availability><!-- 1..1 code Approved | Deprecated --></availability> <folder><!-- 0..* Resource(XdsFolder) folders this document is in --></folder> <subject><!-- 0..1 Resource(Person|Patient|Group|Device) current subject of care --></subject> <content><!-- 0..1 Attachment reference to the content --></content> <extension><!-- 0..* Extension See Extensions --></extension> <text><!-- 1..1 Narrative Text summary of resource (for human interpretation) --></text> </XdsEntry2>
Alternate definitions: Schema/Schematron, RDF (to do), XML, XMI (to do), Resource Profile
Terminology Bindings
| Path | Details | Strength |
|---|---|---|
| XdsEntry2.information.type | LOINC Document Types | complete/preferred |
| XdsEntry2.information.attester.mode | The way in which a person authenticated a document (see http://hl7.org/fhir/document-attestation-mode for values) | complete/required |
| XdsEntry2.availability | The availability status of document (see http://hl7.org/fhir/xds-entry-availability for values) | complete/required |
For further information, see the XdsEntry resource
Search Parameters for RESTful searches. The standard parameters also apply. See Searching for more information.
| $page : integer | Starting offset of the first record to return in the search set | single |
| $count : integer | Number of return records requested. The server is not bound to conform | single |
| $id : token | The logical resource id associated with the resource (must be supported by all servers) | single |
| repositoryId : string | repository - logical or literal url | union |
| mimeType : string | mime type of document | union |
| format : qtoken | format (urn:.. Following rules) | union |
| class : qtoken | particular kind of document | union |
| type : qtoken | precise kind of document | union |
| documentId : string | document id - logical or literal url | union |
| availability : string | Approved | Deprecated | union |
| confidentialityCode : qtoken | as defined by Affinty Domain | union |
| created : date | date equal to time author created document | single |
| created-before : date | date before or equal to time author created document | single |
| created-after : date | date after or equal to time author created document | single |
| event : qtoken | main clinical act(s) | union |
| language : string | human language (RFC 3066) | union |
| folderId : qtoken | folders this document is in | union |
| patientId : qtoken | subject of care of the document | union |
| patientInfo : qtoken | demographic details | union |
| authorName : string | name of human/machine | union |
| authorId : qtoken | id of human/machine | union |
| facilityType : qtoken | type of organizational setting | union |
| practiceSetting : qtoken | clinical speciality of the act | union |
| homeCommunity : string | globally unique community id | union |
| serviceStart : date | date equal to Start time | single |
| serviceStart-before : date | date before or equal to Start time | single |
| serviceStart-after : date | date after or equal to Start time | single |
| serviceStop : date | date equal to Stop time | single |
| serviceStop-before : date | date before or equal to Stop time | single |
| serviceStop-after : date | date after or equal to Stop time | single |
| comments : string | comments as specified by affinity domain | union |
(See Searching).
This is an old version of FHIR retained for archive purposes. Do not use for anything else
Implementers are welcome to experiment with the content defined here, but should note that the contents are subject to change without prior notice.
© HL7.org 2011 - 2012. FHIR v0.06 generated on Tue, Dec 4, 2012 00:04+1100. License