Introduction
CTRP provides two types of Person, Organization, and Family Services:
| Service Category | Description |
|---|---|
| Basic Services | REST-like and SOAP services that provide CRUD-like operations but use a simplified XML schema |
| ISO 21090 Compatible Services | CRUD-style SOAP services that are based on a localized instance of the ISO 21090 healthcare datatypes |
Use these services to query, create, and update persons, organizations, and families in the NCI PO system. This document describes the data and interfaces for these services, as well as the endpoints you can use to invoke them.
We highly recommend that you use the Basic Services rather than the ISO 21090 Compatible Services. They provide a simplified interface while providing at least as much functionality as the ISO 21090 Compatible Services.
Basic Services
Information Model
The data to which the Basic Services provide access can be generally understood from the following information model. Different methods use different cross-sections of this model. Please refer to the examples in the interface specifications for more details.
Interface
The REST-like and SOAP Basic Services follow the interface seen below. However, please refer to the actual interface specification for example URL patterns and SOAP operation names; and parameter names.
Service Specifications
For details for interacting with the Basic Services, refer to the following pages:
WSDL Interfaces
- https://trials.nci.nih.gov/po-webservices/services/PersonService?wsdl
- https://trials.nci.nih.gov/po-webservices/services/OrganizationService?wsdl
- https://trials.nci.nih.gov/po-webservices/services/FamilyService?wsdl
Endpoints
REST-like Services
- https://trials.nci.nih.gov/po-webservices/services/person-rest-service
- https://trials.nci.nih.gov/po-webservices/services/organization-rest-service
- https://trials.nci.nih.gov/po-webservices/services/family-rest-service
Web Services
- https://trials.nci.nih.gov/po-webservices/services/PersonService
- https://trials.nci.nih.gov/po-webservices/services/OrganizationService
- https://trials.nci.nih.gov/po-webservices/services/FamilyService
ISO 21090 Compatible Services
The ISO 21090 Compatible Services use an interface that is highly aligned with the BRIDG model and use a localized version of the ISO 21090 healthcare datatypes. The following subsections provide details on the interface the services expose and how to access the service.
Interface
The following table summarizes the SO 21090 Compatible Services interface. Entities are listed along the rows of the table and operations across the columns. An X indicates that the operation is available for the specified entity.
Entities/Operations | create | getById | getByIds | getByPlayerIds | getServiceSecurityMetadata | query | update | updateStatus | validate |
|---|---|---|---|---|---|---|---|---|---|
ClinicalResearchStaff | X | X | X | X | X | X | X | X | X |
HealthCareFacility | X | X | X | X | X | X | X | X | X |
HealthCareProvider | X | X | X | X | X | X | X | X | X |
IdentifiedOrganization | X | X | X | X | X | X | X | X | X |
IdentifiedPerson | X | X | X | X | X | X | X | X | X |
Organization | X | X | -- | -- | X | X | X | X | X |
OrganizationalContact | X | X | X | X | X | X | X | X | X |
OversightCommittee | X | X | X | X | X | X | X | X | X |
Person | X | X | -- | -- | X | X | X | X | X |
ResearchOrganization | X | X | X | X | X | X | X | X | X |
WSDL Interfaces
- https://trials.nci.nih.gov/po-webservices/services/bridg/ClinicalResearchStaffService?wsdl
- https://trials.nci.nih.gov/po-webservices/services/bridg/HealthCareFacilityService?wsdl
- https://trials.nci.nih.gov/po-webservices/services/bridg/HealthCareProviderService?wsdl
- https://trials.nci.nih.gov/po-webservices/services/bridg/IdentifiedOrganizationService?wsdl
- https://trials.nci.nih.gov/po-webservices/services/bridg/IdentifiedPersonService?wsdl
- https://trials.nci.nih.gov/po-webservices/services/bridg/OrganizationService?wsdl
- https://trials.nci.nih.gov/po-webservices/services/bridg/OrganizationalContactService?wsdl
- https://trials-nci.nih.gov/po-webservices/services/bridg/OversightCommitteeService?wsdl
- https://trials.nci.nih.gov/po-webservices/services/bridg/PersonService?wsdl
- https://trials.nci.nih.gov/po-webservices/services/bridg/ResearchOrganizationService?wsdl
Endpoints
- https://trials.nci.nih.gov/po-webservices/services/bridg/ClinicalResearchStaffService
- https://trials.nci.nih.gov/po-webservices/services/bridg/HealthCareFacilityService
- https://trials.nci.nih.gov/po-webservices/services/bridg/HealthCareProviderService
- https://trials.nci.nih.gov/po-webservices/services/bridg/IdentifiedOrganizationService
- https://trials.nci.nih.gov/po-webservices/services/bridg/IdentifiedPersonService
- https://trials.nci.nih.gov/po-webservices/services/bridg/OrganizationService
- https://trials.nci.nih.gov/po-webservices/services/bridg/OrganizationalContactService
- https://trials.nci.nih.gov/po-webservices/services/bridg/OversightCommitteeService
- https://trials.nci.nih.gov/po-webservices/services/bridg/PersonService
- https://trials.nci.nih.gov/po-webservices/services/bridg/ResearchOrganizationService
