Difference between revisions of "OHF Bridge Documentation"

Revision as of 01:54, 10 November 2006

This page will try to supply missing documentation problems occurring due to the frequent updates and new requirements we receive from the IHE Connectathon 2007 tests.

Changes in Beta 3 Web services API

• Changing pidType to patientIdType in order to avoid HL7 namespace conflicts.
• Adding a "is PHAD" boolean to the RHIO config
• Changed the names of the send document operations and added one that suits the IHE Connectathon 2007 most (see API clarifications)
• In the XDSDocType, changed the name of EncodedDocument to Base64EncodedDocument
• In DateTimeRangeType changes attribute to attributeName (make it more clear)
• In FindDocumentsByPatientId using PatientIdType for the patient type instead of a string
• In DocumentSearchType changed the PatientID from String to be a PatientIdType

API Clarification

Sending documents

In beta 3 we've changed the name of the methods to clarify the document submission process and make testing for Connectathon 2007 as easy as possible. These are the only submission options for Connectathon 2007 testing.

• SubmitDocument (use for Connectathon Test 11746)
  • This service accepts a CDA R2 formatted document and other necessary XDS Metadata needed for submission. This service will automatically extract XDS Metadata from this document and supplement the metadata with values from a DocumentSubmissionMetadataType object. An example of this object will be posted soon.

• ReplaceDocument (use for Connectathon Test 11748)
  • This service accepts a CDA R2 formatted document and other necessary XDS Metadata needed for submission. This service will automatically extract XDS Metadata from this document and supplement the metadata with values from a DocumentSubmissionMetadataType object, including the UUID of the parent document in the XDS registry to be replaced. An example of this object will be posted soon.

Bridge users must provide the patientID and their sourceID (an OID) along with the codesthey feel best describe the submission they are executing. These codes can be fixed, in many cases, based on the kind of application you own. Choices of codes can be found here. A parent document UUID must be provided in the case of document replacement.

General comment regarding the "DecodedDocument" field. Please ignore it. We had placed it there to overcome a problem we had with SOAP object translation and we intend to remove it soon.

Searching for Documents

• DateTimeRangeType is used for searching a document with date constraints.
  • There might be more then one DateTimeRangeType in a search. There are five types of DateTimeRangeType distinguished by their AttributeName:
    • creationTime
    • serviceStartTime
    • serviceStopTime
    • submissionTime
    • lastUpdateTime
  • Time/date (To and From) must follow this format: YYYY[MM[DD]]

Patient ID

Note that we are using a PatientIdType object when referring to patient id, we are not using any longer a simple string. The PatientIdType object contains:

• The idNumber (string) which is the id, for example 16edfc6d4bc341a.
• An AssigningAuthorityType which is an object containing the attributes of the AssigningAuthority which contains:
  • namespaceId (string): the namespace ID. This attribute is allowed for PIX/PDQ but it's use is prohibited in XDS. The value used for PIX/PDQ for Connectathon is HIMSS2005.
  • universalId (string) : in the connectathon it will be 1.3.6.1.4.1.21367.2005.3.7
  • universalIdType (string) : This is always ISO
  • useDefaultAssigningAuthority (boolean) : Default is false. If it is true, then if case the AssigningAuthority is empty, the PIX server AssigningAuthority details will be used for the client.

Audit

All the Audit calls are receiving a AuditMessageType object which contains:

• eventOutcomeIndicator(intiger) The eventOutcomeIndicator should be one of
  • 0 : Success
  • 4 : Minor failure
  • 8 : Serious failure
  • 12: Major failure; action made unavailable
• userIDActiveParticipantConsumer(string): Identity of the consumer
• userIDActiveParticipantRegistry(string): Identity of the registry
• auditSourceId(string): Identity of the participant of the source
• participantObjectId(string): Identity of the participant of the object
• participantObjectQuery(string): Identity of the participant of the query

The methods exposed (which using the above object) are:

• AuditPhiExport
• AuditPhiImport
• AuditLogin
• AuditLogout
• AuditLoginFailure