PatientOutcomesBusinessService_sig by panniuniu

VIEWS: 1 PAGES: 20

									                  caBIG® Service Integration Guide


                   Patient Outcomes Data Service -
                        Business Service – v3.1.2


                                          0.3


                                    2010-03-31




Authors                            Steve Matyas


Editor


Reviewers                          Steve Lustbader, Kunal Modi


Architecture Inception Team


Template Version                   0.31



1
 https://gforge.nci.nih.gov/svnroot/candc/trunk/documents/artifact_templates/integration/
caBIG_Service_Integration_Guide_Template.doc
      Patient Outcomes Data Service - Business Service Integration Guide v.0.3



              DOCUMENT CHANGE HISTORY

Version      Date              Contributor            Description
Number

0.1          2010-03-17        Steve Matyas           Initial Draft

0.2          2010-03-25        Steve Matyas           Updates based on peer review
                                                      feedback

0.3          2010-03-31        Steve Matyas           Updates based on peer review
                                                      feedback




                                        -2-
             Patient Outcomes Data Service - Business Service Integration Guide v.0.3



TABLE OF CONTENTS
1    SERVICE SUMMARY ......................................................................................................................... 4
    1.1 SERVICE DESCRIPTION AND PURPOSE ............................................................................................... 4
    1.2 SERVICE IMPLEMENTER’S DETAILS .................................................................................................. 4
    1.3 REFERENCED PLATFORM SPECIFIC MODEL....................................................................................... 5
    1.4 DEVIATIONS FROM THE PLATFORM SPECIFIC MODEL ....................................................................... 5
       1.4.1 Technical Deviation ................................................................................................................. 5
       1.4.2 Conformance Deviation ........................................................................................................... 5
2    DISCOVERING THE SERVICE ......................................................................................................... 7
    2.1 PRE-CONDITIONS FOR DISCOVERING THE SERVICE ........................................................................... 7
       2.1.1 Point of Contact for Pre-conditions ......................................................................................... 7
    2.2 SERVICE DISCOVERY MECHANISM ................................................................................................... 7
       2.2.1 caGrid Index Service ................................................................................................................ 7
       2.2.2 Direct URL ............................................................................................................................... 8
3    CONNECTING TO THE SERVICE ................................................................................................... 9
    3.1 PRE-CONDITIONS FOR CONNECTING TO THE SERVICE ....................................................................... 9
       3.1.1 Licensing Pre-conditions.......................................................................................................... 9
       3.1.2 Security Pre-conditions ............................................................................................................ 9
4    INTERACTING WITH THE SERVICE ...........................................................................................13
    4.1 SEQUENCE OF OPERATIONS .............................................................................................................13
    4.2 MESSAGE CONSTRUCT .....................................................................................................................13
       4.2.1 Supporting Information ...........................................................................................................13
       4.2.2 Actual Message Format ..........................................................................................................13
       4.2.3 Message Attachments ..............................................................................................................13
    4.3 INFORMATION CONSTRUCT ..............................................................................................................13
5    TERMINATING CONNECTION WITH THE SERVICE ..............................................................15
    5.1     CLOSING THE CONNECTION .............................................................................................................15
    5.2     POST CONNECTION CLEANUP ..........................................................................................................15
6    AVAILABLE CLIENT FOR CONNECTING TO THE SERVICE ................................................16
    6.1     CONNECTING USING THE PROVIDED CLIENT ....................................................................................16
    6.2     CONNECTING WITHOUT THE PROVIDED CLIENT ...............................................................................16
7    APPENDIX A - RELEVANT STANDARDS .....................................................................................17
8    APPENDIX B - GLOSSARY ...............................................................................................................18
9    APPENDIX C - EXAMPLES ..............................................................................................................19




                                                                        -3-
        Patient Outcomes Data Service - Business Service Integration Guide v.0.3


 1 Service Summary
1.1 Service Description and Purpose
The first release of this Patient Outcomes Service provides an application interface for
the managing and reporting of patient outcomes data in a clinical setting and is the first
step in building the definitive Patient Outcomes Service. Patient outcomes data can be
provided by a clinician or by an Electronic Health Record (EHR) system. The service
interface has been implemented as a user-facing application in this first release, although
it is envisioned to be integrated with other clinical domain services, such as EHR.
This service will provide clinicians or administrators at clinician’s offices with the ability
to submit outcome data for the cancer patients under their care. It will also provide them
with the ability to query the data they submitted.
The development of a common, reusable set of interfaces provided by this service will
facilitate standardization, integration, and interoperability between systems that collect
and report patient outcome data.
This service specification provides a key infrastructure component for NCI to support
Patient Outcomes information management and integration with other systems. The
service leverages the NCI Enterprise Services of Correlation, Organization, Person and
Protocol Abstraction (also known as COPPA). It is the first release of this effort and
focuses on enabling collection of patient outcome data. It is anticipated to evolve in
future releases to fulfill the goals of NCI’s larger vision of a comprehensive outcome data
repository.

1.2 Service Implementer’s Details
Implementing             CBIIT
Institute’s Name

Point of Contact’s       NA
Phone Number

Implementing             2115 E. Jefferson St.
Institute’s Address      Rockville, MD 20852

Point of Contact’s       Edmond Mulaire
Name

Point of Contact’s       ncictrp@mail.nih.gov
Email Address

For general questions or suggestions on any aspect of this program, you can
contact CTRP directly at ncictrp@mail.nih.gov. Also, if you wish to ensure that
you are kept informed about CTRP, please send an e-mail message to
ncictrp@mail.nih.gov, asking to be added to the CTRP mailing list.

                                            -4-
       Patient Outcomes Data Service - Business Service Integration Guide v.0.3




1.3 Referenced Platform Specific Model


Platform Specific Model Platform Specific            Description & Link to the
Name and Service        Model and Service            Platform Specific Model and
Specification           Specification Version        Service Specification

Patient Outcomes            0.0.7                    https://ncisvn.nci.nih.gov/svn/pod
Platform Specific Model                              s/trunk/specifications/PatientOutc
and Service Specification                            omesDataService_psmss.doc



1.4 Deviations from the Platform Specific Model
  1.4.1 Technical Deviation
Technical            Reason                        Effects
Deviation




  1.4.2 Conformance Deviation

1.4.2.1 Functional Deviation


Functional         Deviation        Reasons                  Effects
Deviation          Level
                   (Profile /
                   Operation)




1.4.2.2 Semantic Deviation


Semantic             Reason                        Effects
Deviation


                                          -5-
       Patient Outcomes Data Service - Business Service Integration Guide v.0.3


LesionAssessment. Property was inadvertently       Attribute is always null / empty and
treatmentRegimenI added to the XSD during          is ignored and will be removed in
dentifier is always development, a bug.            subsequent release.
null/empty




                                         -6-
       Patient Outcomes Data Service - Business Service Integration Guide v.0.3



 2 Discovering the Service


2.1 Pre-conditions for Discovering the Service


Discovery Pre-conditions      Description                   How to satisfy them




  2.1.1 Point of Contact for Pre-conditions
For assistance discovering a caGrid service, please submit questions to the caBIG
Knowledge Center Forum for caGrid, https://cabig-kc.nci.nih.gov/CaGrid/forums/.
NOTE: New users will be required to create an account in order to post questions to the
forums.

Point of Contact’s      NA
Name

Point of Contact’s      NA
Institute’s Name

Point of Contact’s      NA
Phone Number

Point of Contact’s      NA
Email Address



2.2 Service Discovery Mechanism
  2.2.1 caGrid Index Service
Service Discovery       caGrid Index Service – Training Tier
Mechanism

Service Discovery       http://index.training.cagrid.org:8080/wsrf/services/DefaultInde
Endpoint                xService

Additional Notes        The registered service (main service context) is called
                        OutcomesServices although the service described within this



                                          -7-
       Patient Outcomes Data Service - Business Service Integration Guide v.0.3


                       document is named Business (service context).



  2.2.2 Direct URL
Service Discovery      Direct URL
Mechanism

Service Discovery      https://ctms-services-outcomes-3-1-
Endpoint               demo.nci.nih.gov:19043/wsrf/services/cagrid/Business

Additional Notes       The URL provided above is a direct URL point to the service.
                       You can use this URL to access the service directly without any
                       additional discovery steps involved. The registered service
                       (main service context) is called OutcomesServices although the
                       service described within this document is named Business
                       (service context).




                                         -8-
        Patient Outcomes Data Service - Business Service Integration Guide v.0.3



 3 Connecting to the Service
3.1 Pre-conditions for Connecting to the Service
  3.1.1 Licensing Pre-conditions


Licensing Pre-conditions        Description                  How to satisfy them




3.1.1.1 Point of Contact
Not applicable as no licensing is prerequisites exist.

Point of Contact’s         NA
Name

Point of Contact’s         NA
Institute’s Name

Point of Contact’s         NA
Phone Number

Point of Contact’s         NA
Email Address



  3.1.2 Security Pre-conditions

3.1.2.1 Authentication Pre-conditions


Pre-conditions                  Description                  How to satisfy them

Obtain a grid credential        Users must have valid Grid   Follow instructions:
(Dorian User Account)           Credentials obtained from    http://cagrid.org/display/cag
                                the NCI Training Grid        rid13tutorials/Create+User+
                                                             Account for instructions. To
                                                             register for a grid account
                                                             on the Training Grid go to
                                                             https://portal.training.cagrid


                                            -9-
       Patient Outcomes Data Service - Business Service Integration Guide v.0.3


                                                            .org/web/guest/register and
                                                            complete the form.



3.1.2.1.1 Point of Contact
Point of Contact’s     NA
Name

Point of Contact’s     NA
Institute’s Name

Point of Contact’s     NA
Phone Number

Point of Contact’s     NA
Email Address



3.1.2.1.2 Anonymous Access List
No operations allow for anonymous access.


3.1.2.2 Authorization Pre-conditions


Pre-conditions                Description                   How to satisfy them

Create a local User Account   Users must have a local a     Users may register to use
(Outcomes User Account)       user account created within   the application by using the
                              the PODS System.              Patient Outcomes User
                                                            Service to create an
                                                            account.



3.1.2.2.1 Method Level List


Operations Name               Authorization Pre-            How to satisfy them
                              condition

get                           Needs to be a member of       Invoke the createUser


                                         - 10 -
          Patient Outcomes Data Service - Business Service Integration Guide v.0.3


                                ‘Outcomes’ group              operation on the Outcomes
                                                              User Service to create an
                                                              account and granted
                                                              appropriate authorization

getById                         Needs to be a member of       Invoke the createUser
                                ‘Outcomes’ group              operation on the Outcomes
                                                              User Service to create an
                                                              account and granted
                                                              appropriate authorization

write                           Needs to be a member of       Invoke the createUser
                                ‘Outcomes’ group              operation on the Outcomes
                                                              User Service to create an
                                                              account and granted
                                                              appropriate authorization



3.1.2.2.2 Data Element Level List


Data Element Name               Authorization Pre-            How to satisfy them
                                condition

Cycle                           Needs to be member of         Invoke the createUser
                                Outcomes Group                operation on the Outcomes
DeathInformation
                                                              User Service to create an
Diagnosis                                                     account and granted
DiseaseEvaluation                                             appropriate authorization

DrugBiologic
LesionAssessment
OffTreatment
Pathology
PerformanceStatus
PriorTherapiesItem
PriorTherapy
Radiation
Staging
Surgery



                                           - 11 -
          Patient Outcomes Data Service - Business Service Integration Guide v.0.3


TreatmentRegimen
TumorMarker
Patient



3.1.2.2.3 Point of Contact
Point of Contact’s        NA
Name

Point of Contact’s        NA
Institute’s Name

Point of Contact’s        NA
Phone Number

Point of Contact’s        NA
Email Address




                                           - 12 -
         Patient Outcomes Data Service - Business Service Integration Guide v.0.3



 4 Interacting with the Service


4.1 Sequence of Operations


Operation Name                 Description

get                            Get all Patient Outcomes available to user

getById                        Get a particular Patient Outcomes for update

update                         Update the retrieved Patient Outcomes information

create                         Create new Patient Outcomes



4.2 Message Construct
  4.2.1 Supporting Information


Information Element            Location                      Description
Name




  4.2.2 Actual Message Format




  4.2.3 Message Attachments




4.3 Information Construct



                                          - 13 -
Patient Outcomes Data Service - Business Service Integration Guide v.0.3




                                 - 14 -
     Patient Outcomes Data Service - Business Service Integration Guide v.0.3



5 Terminating Connection with the Service


5.1 Closing the Connection



5.2 Post Connection Cleanup




                                      - 15 -
       Patient Outcomes Data Service - Business Service Integration Guide v.0.3



 6 Available Client for Connecting to the Service


6.1 Connecting using the provided Client


Client Name            Patient Outcomes Data Service Client API

Client Location        http://gforge.nci.nih.gov/frs/?group_id=504 (Download the
                       appropriate PODS Client Distribution)

Documentation          http://gforge.nci.nih.gov/frs/?group_id=504
Location

API Documentation      http://gforge.nci.nih.gov/frs/?group_id=504
Location

Technical Pre-                Globus 4.0.3 needs to be installed.
conditions                    JAVAHOME and CLASSPATH environment variables
                               should be set



6.2 Connecting without the provided Client
SoapUI can also be used to call the services.




                                        - 16 -
         Patient Outcomes Data Service - Business Service Integration Guide v.0.3



 7 Appendix A - Relevant Standards

Standards           Description

BRIDG v 2.1         The Patient Outcomes services are using the NCI’s BRIDG v 2.1
and 3.0             and 3.0. BRIDG 3.0 was released during development of this effort
                    and therefore the modified semantic structures from 3.0 that applied
                    to Patient Outcomes service were implemented.

HL7 v3              The Patient Outcomes services are leveraging the NCI NES –
                    COPPA services. The Core COPPA services of Person and
                    Organization are aligned with HL7 v3 Reference Information Model
                    semantics.

ISO 21090           The Patient Outcomes services are using NCI’s constrained version
                    of the ISO 20190 implementation.

W3C.REC-            Simple Object Access Protocol ver 1.1 is used to interact with the
soap12-part1-       service
20030624


ITEF RFC 2616       Hypertext Transfer Protocol -- HTTP/1.1




                                          - 17 -
        Patient Outcomes Data Service - Business Service Integration Guide v.0.3



 8 Appendix B - Glossary

Term          Description

BRIDG         The Biomedical Research Integrated Domain Group (BRIDG) has
              developed a comprehensive domain analysis model representing
              biomedical/clinical research.

COPPA         NCI’s Enterprise Services of Correlation, Organization, Person and
              Protocol Abstraction.




                                         - 18 -
 9 Appendix C - Examples
Security SOAP Envelope
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/03/addressing">
    <soapenv:Header>
        <wsa:MessageID soapenv:mustUnderstand="0">uuid:5775ac50-32a0-11df-8059-f32846b54dae
        </wsa:MessageID>
        <wsa:To soapenv:mustUnderstand="0">
            https://ctms-services-outcomes-3-1-dev.nci.nih.gov:19043/wsrf/services/cagrid/Business</wsa:To>
        <wsa:Action soapenv:mustUnderstand="0">
            http://security.introduce.cagrid.nci.nih.gov/ServiceSecurity/GetServiceSecurityMetadataRequest</wsa:Action>
        <wsa:From soapenv:mustUnderstand="0">
            <wsa:Address>http://schemas.xmlsoap.org/ws/2004/03/addressing/role/anonymous
            </wsa:Address>
        </wsa:From>
    </soapenv:Header>
    <soapenv:Body>
        <GetServiceSecurityMetadataRequest xmlns="http://security.introduce.cagrid.nci.nih.gov/ServiceSecurity"/>
    </soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/03/addressing">
    <soapenv:Header>
        <wsa:MessageID soapenv:mustUnderstand="0">uuid:57eed3f0-32a0-11df-8791-dee208bdce74
        </wsa:MessageID>
        <wsa:To soapenv:mustUnderstand="0">http://schemas.xmlsoap.org/ws/2004/03/addressing/role/anonymous
        </wsa:To>
        <wsa:Action soapenv:mustUnderstand="0">
            http://security.introduce.cagrid.nci.nih.gov/ServiceSecurity/GetServiceSecurityMetadataResponse</wsa:Action>
        <wsa:From soapenv:mustUnderstand="0">
            <wsa:Address>https://ctms-services-outcomes-3-1-dev.nci.nih.gov:19043/wsrf/services/cagrid/Business
            </wsa:Address>
        </wsa:From>
        <wsa:RelatesTo RelationshipType="wsa:Reply" soapenv:mustUnderstand="0">uuid:5775ac50-32a0-11df-8059-
f32846b54dae</wsa:RelatesTo>
    </soapenv:Header>
    <soapenv:Body>
        <GetServiceSecurityMetadataResponse xmlns="http://security.introduce.cagrid.nci.nih.gov/ServiceSecurity">
            <ns1:ServiceSecurityMetadata xmlns:ns1="gme://caGrid.caBIG/1.0/gov.nih.nci.cagrid.metadata.security">
                <ns1:defaultCommunicationMechanism anonymousPermitted="false">
                    <ns1:GSITransport protectionLevel="privacy"/>
                </ns1:defaultCommunicationMechanism>
                              Patient Outcomes Data Service - Business Service Integration Guide v.0.3


                <ns1:operations>
                    <ns1:Operation name="getServiceSecurityMetadata">
                        <ns1:CommunicationMechanism anonymousPermitted="true">
                            <ns1:None/>
                        </ns1:CommunicationMechanism>
                    </ns1:Operation>
                </ns1:operations>
            </ns1:ServiceSecurityMetadata>
        </GetServiceSecurityMetadataResponse>
    </soapenv:Body>
</soapenv:Envelope>

Get Patient (Search)
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/03/addressing">
    <soapenv:Header>
        <wsa:MessageID soapenv:mustUnderstand="0">uuid:58209250-32a0-11df-8059-f32846b54dae
        </wsa:MessageID>
        <wsa:To soapenv:mustUnderstand="0">
            https://ctms-services-outcomes-3-1-dev.nci.nih.gov:19043/wsrf/services/cagrid/Business</wsa:To>
        <wsa:Action soapenv:mustUnderstand="0">
            http://enterpriseservices.nci.nih.gov/OutcomesServices/Business/GetRequest</wsa:Action>
        <wsa:From soapenv:mustUnderstand="0">
            <wsa:Address>http://schemas.xmlsoap.org/ws/2004/03/addressing/role/anonymous
            </wsa:Address>
        </wsa:From>
    </soapenv:Header>
    <soapenv:Body>
        <GetRequest xmlns="http://enterpriseservices.nci.nih.gov/OutcomesServices/Business">
            <patient>
                <ns1:Patient xsi:type="ns1:Patient" xmlns:ns1="http://business.outcomes.services.coppa.nci.nih.gov"/>
            </patient>
        </GetRequest>
    </soapenv:Body>
</soapenv:Envelope>




                                          - 20 -

								
To top