Ihe iti technical Framework Supplement 2008-2009 Sharing Value Sets (svs) Draft Draft following meeting face to face March 10 – 13, 2008
Download 190.79 Kb.
|
- Navigate this page:
- SVS Integration Profile Options
- SVS Security Considerations
- 3.XX.3 Referenced Standard
- 3.XX.4.1 Retrieve Value Set Request
- 3.XX.4.1.3 Expected Actions
- 3.XX.4.2 Retrieve Value Set Response
- 3.XX.4.2.3 Expected Actions
- 3.XX.4.2.4 Security Considerations
- 3.XX.5.1 Sample SOAP Messages
- 3.XX.5.1.1 Sample Retrieve Value Set SOAP Request
- 3.XX.5.1.2 Sample Retrieve Value Set SOAP Response
- 3.XX.6 Security Requirements
Actors/ TransactionsFigure 1.2-2 shows the actors directly involved in the SVS Integration Profile and the relevant transactions between them. Other actors that may be indirectly involved due to their participation in other related profiles are not necessarily shown. As well, the creation of a Value Set is not covered by this profile. The subject will be treated one the basic infrastructure is in place. 
Figure 1.1-2 SVS Actor Diagram Table 1.1-2 lists the transactions for each actor directly involved in the SVS Profile. In order to claim support of this Integration Profile, an implementation must perform the required transactions (labeled “R”). Transactions labeled “O” are optional. A complete list of options defined by this Integration Profile and that implementations may choose to support is listed in Volume I, Section 1.3. Table 1.2-1. SVS Integration Profile - Actors and Transactions
This section describes the process and information flow when a ValueSet Consumer will retrieve a Value Set from a Value Set Repository  Figure X.2-1. Basic Process Flow in SVS Profile
To be discussed ValueSet Repository: actor whose role is to store the brand new ValueSets It also has the responsibility to register the metadata of each new or updated ValueSet it receives from the ValueSet Source. ValueSet Consumer: an actor who queries the ValueSet Registry for a specific new Value Set or for an updated one. It will then retrieve it from the ValueSet Repository based on its OID. The ValueSet Consumer can be paired up with the Content Creator/Consumer (application, CT scanner) so that the later one can use the Value Sets required for encoding. Retrieve Value Set: The Value Set Consumer retrieves a new Value Set from the Value Set Repository. Volume 2 - Transactions Add sections 3.Y 3.XX Retrieve Value SetThis section corresponds to Transaction ITI-XX of the IHE Technical Framework. The Value Set Consumer and Value Set Repository actors use transaction ITI-XX.
3.XX.1 ScopeThis transaction is used by the Value Set Consumer to retrieve a Value Set from the Value Set Repository. The Value Set Consumer has already obtained the Value Set unique Id by means outside of the scope of this transaction. 
Figure 3.XX.2: Use Case Roles SVS Actors: Actor: Value Set Consumer Role: Obtains Value Set Actor: Value Set Repository Role: Provides Value Set 3.XX.3 Referenced Standard
Figure 3.XX.4: Interaction Diagram 3.XX.4.1 Retrieve Value Set Request3.XX.4.1.1Trigger EventsHaving obtained the valueSetUniqueId, the Value Set Consumer will start the Retrieve Value Set Request with the Value Set Repository. 3.XX.4.1.2 Message SemanticsThe Retrieve Value Set Request shall carry the following information: A required valueSetUniqueId that identifies the value set within the repository. 3.XX.4.1.3 Expected ActionsWhen receiving a Retrieve Value Set Request, a Value Set Repository shall generate a Retrieve Value Set Response containing the requested value set or error codes if the value set could not be retrieved. 3.XX.4.1.4 Security Considerations3.XX.4.2 Retrieve Value Set Response3.XX.4.2.1 Trigger EventsThis message will be triggered by a Retrieve Value Set Request Message 3.XX.4.2.2 Message SemanticsThe Retrieve Value Set Response Message shall carry the following information: For the returned value set:
For each value set concept, the following metadata is returned:
Errors or warnings in case the value set could not be retrieved successfully. 3.XX.4.2.3 Expected ActionsA Value Set Repository shall retrieve the value set indicated in the request. The Value Set Repository shall return the value set or an error code in case the value set could not be retrieved. 3.XX.4.2.4 Security Considerations3.XX.5 Protocol RequirementsThe protocol for the Retrieve Value Set is based on SOAP12 (optionally SOAP11) WSDL Namespace Definitions
These are the requirements for the Retrieve Value Set transaction presented in the order in which they would appear in the WSDL definition: The following types shall be imported (xsd:import) in the /definitions/types section: namespace="urn:ihe:iti:svs:2008", schema="IHESVS.xsd" The /definitions/message/part/@element attribute of the Retrieve Value Set Request message shall be defined as “ihe:RetrieveValueSetRequest” The /definitions/message/part/@element attribute of the Retrieve Value Set Response message shall be defined as “ihe:RetrieveValueSetResponse” The /definitions/portType/operation/input/@wsaw:Action attribute for the Retrieve Value Set Request message shall be defined as “urn:ihe:iti:2008:RetrieveValueSet” The /definitions/portType/operation/output/@wsaw:Action attribute for the Retrieve Value Set Response message shall be defined as “urn:ihe:iti:2008:RetrieveValueSetResponse” The /definitions/binding/operation/soap12:operation/@soapAction attribute shall be defined as “urn:ihe:iti:2008:RetrieveValueSet” These are the requirements that affect the wire format of the SOAP message. The other WSDL properties are only used within the WSDL definition and do not affect interoperability. Full sample request and response messages are in section 3.XX.5.1 Sample SOAP Messages. A full WSDL for the Value Set Repository actor is found in an Appendix to this supplement, as well as on the IHE ftp site at ftp://ftp.ihe.net The A required A required /ihe:RetrieveValueSetResponse/ihe:ValueSet element, containing a required /ihe:RetrieveValueSetResponse/ihe:ValueSet@id attribute a required /ihe:RetrieveValueSetResponse/ihe:ValueSet@displayName attribute zero or more /ihe:RetrieveValueSetResponse/ihe:ValueSet/ihe:SourceCodeSystem elements, where the lack of this element indicates that the value set itself is a code system one or more /ihe:RetrieveValueSetResponse/ihe:ValueSet/ihe:ValueSetConcept elements, representing the concepts within the value set. The The A full XML Schema Document for the SVS types is included in an Appendix to this supplement, and is also available on the IHE ftp site at ftp://ftp.ihe.net 3.XX.5.1 Sample SOAP MessagesThe samples in the following two sections show a typical SOAP request and its relative SOAP response. The sample messages also show the WS-Addressing headers All of the samples presented in this section are also available online on the IHE FTP site at ftp://ftp.ihe.net/IT_Infrastructure/iheitiyr5-2007-2008/Technical_Cmte/SupportMaterial/. 3.XX.5.1.1 Sample Retrieve Value Set SOAP RequestNote to the editor: please keep the following format for the sample text – courier new, 8pt, no spacing before and after the paragraph, tab stops every 1/8 of an inch for the first inch. xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing"> 3.XX.5.1.2 Sample Retrieve Value Set SOAP ResponseNote to the editor: please keep the following format for the sample text – courier new, 8pt, no spacing before and after the paragraph, tab stops every 1/8 of an inch for the first inch. xmlns="urn:ihe:iti:svs:2008" xmlns:hl7="urn:hl7-org:v3"> 3.XX.6 Security RequirementsBIBLIOGRAPHY
 
Copyright © 2008: IHE International Directory: dicom dicom -> Dicom standards committee dicom -> Dicom correction Proposal dicom -> Dicom correction Proposal Download 190.79 Kb. Share with your friends:
|