View Javadoc
1   /*
2    * Copyright 2009 the original author or authors.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *     
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.openehealth.ipf.commons.ihe.xds.core.metadata;
17  
18  /**
19   * List of XDS related vocabulary constants.
20   * @author Jens Riemschneider
21   */
22  public abstract class Vocabulary {
23      private Vocabulary() {
24          throw new UnsupportedOperationException("Cannot be instantiated");
25      }
26      
27      /**
28       * XDSDocumentEntry objectType for Stable Document Entries
29       * @deprecated use {@link DocumentEntryType#STABLE}.
30       */
31      @Deprecated
32      public static final String STABLE_DOC_ENTRY = DocumentEntryType.STABLE.getUuid();
33      /**
34       * XDSDocumentEntry classification node.
35       * @deprecated by IHE CP-ITI-544.  Please use {@link #STABLE_DOC_ENTRY} instead.
36       */
37      @Deprecated
38      public static final String DOC_ENTRY_CLASS_NODE = STABLE_DOC_ENTRY;
39      /**
40       * XDSDocumentEntry objectType for On-Demand Document Entries
41       * @deprecated use {@link DocumentEntryType#ON_DEMAND}.
42       */
43      @Deprecated
44      public static final String ON_DEMAND_DOC_ENTRY = DocumentEntryType.ON_DEMAND.getUuid();
45  
46  
47      public enum DisplayNameUsage {REQUIRED, OPTIONAL}
48      public enum NodeRepresentationUsage {REQUIRED, PROHIBITED}
49  
50      /** Author External Classification Scheme of the Document Entry */
51      public static final String DOC_ENTRY_AUTHOR_CLASS_SCHEME =
52          "urn:uuid:93606bcf-9494-43ec-9b4e-a7748d1a838d";
53  
54      /** classCode External Classification Scheme of the Document Entry */
55      public static final String DOC_ENTRY_CLASS_CODE_CLASS_SCHEME = 
56          "urn:uuid:41a5887f-8865-4c09-adf7-e362475b143a";
57  
58      /** confidentialityCode External Classification Scheme of the Document Entry */
59      public static final String DOC_ENTRY_CONFIDENTIALITY_CODE_CLASS_SCHEME = 
60          "urn:uuid:f4f85eac-e6cb-4883-b524-f2705394840f";
61      
62      /** eventCode External Classification Scheme of the Document Entry */
63      public static final String DOC_ENTRY_EVENT_CODE_CLASS_SCHEME = 
64          "urn:uuid:2c6b8cb7-8b2a-4051-b291-b1ae6a575ef4";    
65  
66      /** formatCode External Classification Scheme of the Document Entry */
67      public static final String DOC_ENTRY_FORMAT_CODE_CLASS_SCHEME = 
68          "urn:uuid:a09d5840-386c-46f2-b5ad-9c3699a4309d";
69  
70      /** healthcareFacitilityTypeCode External Classification Scheme of the Document Entry */
71      public static final String DOC_ENTRY_HEALTHCARE_FACILITY_TYPE_CODE_CLASS_SCHEME =
72          "urn:uuid:f33fb8ac-18af-42cc-ae0e-ed0b0bdb91e1";
73  
74      /** practiceSettingCode ExternalIdentifier of the Document Entry */
75      public static final String DOC_ENTRY_PRACTICE_SETTING_CODE_CLASS_SCHEME =
76          "urn:uuid:cccf5598-8b07-4b77-a05e-ae952c785ead";
77      
78      /** typeCode ExternalIdentifier of the Document Entry */
79      public static final String DOC_ENTRY_TYPE_CODE_CLASS_SCHEME =
80          "urn:uuid:f0306f51-975f-434e-a61c-c59651d33983";
81  
82      /** limitedMetadata External Classification Scheme of the Document Entry */
83      public static final String DOC_ENTRY_LIMITED_METADATA_CLASS_SCHEME =
84          "urn:uuid:ab9b591b-83ab-4d03-8f5d-f93b1fb92e85";
85  
86      /** patientId ExternalIdentifier of the Document Entry */
87      public static final String DOC_ENTRY_PATIENT_ID_EXTERNAL_ID =
88          "urn:uuid:58a6f841-87b3-4a3e-92fd-a8ffeff98427";
89      
90      /** uniqueId ExternalIdentifier of the Document Entry */
91      public static final String DOC_ENTRY_UNIQUE_ID_EXTERNAL_ID =
92          "urn:uuid:2e82c1f6-a085-4c72-9da3-8640a32e42ab";
93      
94      /** Localized String used for the patient ID external identifier of a document entry */
95      public static final String DOC_ENTRY_LOCALIZED_STRING_PATIENT_ID = "XDSDocumentEntry.patientId";
96  
97      /** Localized String used for the unique ID external identifier of a document entry */
98      public static final String DOC_ENTRY_LOCALIZED_STRING_UNIQUE_ID = "XDSDocumentEntry.uniqueId";
99  
100 
101     
102     
103     /** XDSFolder classification node */
104     public static final String FOLDER_CLASS_NODE = 
105         "urn:uuid:d9d542f3-6cc4-48b6-8870-ea235fbc94c2";    
106     
107     /** codeList External Classification Scheme of the folder */
108     public static final String FOLDER_CODE_LIST_CLASS_SCHEME =
109         "urn:uuid:1ba97051-7806-41a8-a48b-8fce7af683c5";
110 
111     /** limitedMetadata External Classification Scheme of the Folder */
112     public static final String FOLDER_LIMITED_METADATA_CLASS_SCHEME =
113         "urn:uuid:2c144a76-29a9-4b7c-af54-b25409fe7d03";
114 
115     /** patientId ExternalIdentifier of the Folder */
116     public static final String FOLDER_PATIENT_ID_EXTERNAL_ID =
117         "urn:uuid:f64ffdf0-4b97-4e06-b79f-a52b38ec2f8a";
118     
119     /** uniqueId ExternalIdentifier of the Folder */
120     public static final String FOLDER_UNIQUE_ID_EXTERNAL_ID =
121         "urn:uuid:75df8f67-9973-4fbe-a900-df66cefecc5a";
122 
123     /** Localized String used for the patient ID external identifier of a folder */
124     public static final String FOLDER_LOCALIZED_STRING_PATIENT_ID = "XDSFolder.patientId";
125 
126     /** Localized String used for the unique ID external identifier of a folder */
127     public static final String FOLDER_LOCALIZED_STRING_UNIQUE_ID = "XDSFolder.uniqueId";
128 
129     
130     
131     
132 
133     /** XDSSubmissionSet classification node */
134     public static final String SUBMISSION_SET_CLASS_NODE = 
135         "urn:uuid:a54d6aa5-d40d-43f9-88c5-b4633d873bdd";
136     
137     /** Author External Classification Scheme of the Submission Set */
138     public static final String SUBMISSION_SET_AUTHOR_CLASS_SCHEME = 
139         "urn:uuid:a7058bb9-b4e4-4307-ba5b-e3f0ab85e12d";
140 
141     /** contentTypeCode External Classification Scheme of the Submission Set */
142     public static final String SUBMISSION_SET_CONTENT_TYPE_CODE_CLASS_SCHEME = 
143         "urn:uuid:aa543740-bdda-424e-8c96-df4873be8500";
144 
145     /** limitedMetadata External Classification Scheme of the Submission Set */
146     public static final String SUBMISSION_SET_LIMITED_METADATA_CLASS_SCHEME =
147         "urn:uuid:5003a9db-8d8d-49e6-bf0c-990e34ac7707";
148 
149     /** patientId ExternalIdentifier of the Submission Set */
150     public static final String SUBMISSION_SET_PATIENT_ID_EXTERNAL_ID =
151         "urn:uuid:6b5aea1a-874d-4603-a4bc-96a0a7b38446";
152     
153     /** uniqueId ExternalIdentifier of the Submission Set */
154     public static final String SUBMISSION_SET_UNIQUE_ID_EXTERNAL_ID =
155         "urn:uuid:96fdda7c-d067-4183-912e-bf5ee74998a8";
156 
157     /** sourceId ExternalIdentifier of the Submission Set */
158     public static final String SUBMISSION_SET_SOURCE_ID_EXTERNAL_ID =
159         "urn:uuid:554ac39e-e3fe-47fe-b233-965d2a147832";
160 
161     /** Localized String used for the patient ID external identifier of a submission set */
162     public static final String SUBMISSION_SET_LOCALIZED_STRING_PATIENT_ID = "XDSSubmissionSet.patientId";
163 
164     /** Localized String used for the unique ID external identifier of a submission set */
165     public static final String SUBMISSION_SET_LOCALIZED_STRING_UNIQUE_ID = "XDSSubmissionSet.uniqueId";
166 
167     /** Localized String used for the source ID external identifier of a submission set */
168     public static final String SUBMISSION_SET_LOCALIZED_STRING_SOURCE_ID = "XDSSubmissionSet.sourceId";
169 
170     
171     
172     /** Documentation External Classification Scheme of the Association */
173     public static final String ASSOCIATION_DOC_CODE_CLASS_SCHEME = 
174         "urn:uuid:abd807a3-4432-4053-87b4-fd82c643d1f3";
175 
176 
177 
178 
179     /** Name of the slot that is used for author persons */
180     public static final String SLOT_NAME_AUTHOR_PERSON = "authorPerson";
181     
182     /** Name of the slot that is used for author institutions */
183     public static final String SLOT_NAME_AUTHOR_INSTITUTION = "authorInstitution";
184 
185     /** Name of the slot that is used for author roles */
186     public static final String SLOT_NAME_AUTHOR_ROLE = "authorRole";
187 
188     /** Name of the slot that is used for author specialties */
189     public static final String SLOT_NAME_AUTHOR_SPECIALTY = "authorSpecialty";
190 
191     /** Name of the slot that is used for author telecommunication addresses */
192     public static final String SLOT_NAME_AUTHOR_TELECOM = "authorTelecommunication";
193 
194     /** Name of the slot that is used for coding schemes */
195     public static final String SLOT_NAME_CODING_SCHEME = "codingScheme";
196 
197     /** Name of the slot that is used for the creation time */
198     public static final String SLOT_NAME_CREATION_TIME = "creationTime";
199 
200     /** Name of the slot that is used for the last update time */
201     public static final String SLOT_NAME_LAST_UPDATE_TIME = "lastUpdateTime";
202     
203     /** Name of the slot that is used for the hash code */
204     public static final String SLOT_NAME_HASH = "hash";
205 
206     /** Name of the slot that is used for the language code */
207     public static final String SLOT_NAME_LANGUAGE_CODE = "languageCode";
208 
209     /** Name of the slot that is used for the legal authenticator */
210     public static final String SLOT_NAME_LEGAL_AUTHENTICATOR = "legalAuthenticator";
211     
212     /** Name of the slot that is used for the service start time */
213     public static final String SLOT_NAME_SERVICE_START_TIME = "serviceStartTime";
214 
215     /** Name of the slot that is used for the service stop time */
216     public static final String SLOT_NAME_SERVICE_STOP_TIME = "serviceStopTime";
217     
218     /** Name of the slot that is used for the size */
219     public static final String SLOT_NAME_SIZE = "size";
220     
221     /** Name of the slot that is used for the source patient ID */
222     public static final String SLOT_NAME_SOURCE_PATIENT_ID = "sourcePatientId";
223 
224     /** Name of the slot that is used for the source patient info */
225     public static final String SLOT_NAME_SOURCE_PATIENT_INFO = "sourcePatientInfo";
226     
227     /** Name of the slot that is used for the URI */
228     public static final String SLOT_NAME_URI = "URI";
229     
230     /** Name of the slot that is used for the unique ID of the repository (using only in XDS.b) */
231     public static final String SLOT_NAME_REPOSITORY_UNIQUE_ID = "repositoryUniqueId";
232     
233     /** Name of the slot that is used for the intended recipients */
234     public static final String SLOT_NAME_INTENDED_RECIPIENT = "intendedRecipient";
235     
236     /** Name of the slot that is used for the submission time */
237     public static final String SLOT_NAME_SUBMISSION_TIME = "submissionTime";
238     
239     /** Name of the slot that is used for association labeling of the submission set */
240     public static final String SLOT_NAME_SUBMISSION_SET_STATUS = "SubmissionSetStatus";
241 
242     /** Name of the slot that is used for version number of documents previous version */
243     public static final String SLOT_NAME_PREVIOUS_VERSION = "PreviousVersion";
244 
245     /** Name of the slot that is used for original association type status on update associations */
246     public static final String SLOT_NAME_ORIGINAL_STATUS = "OriginalStatus";
247 
248     /** Name of the slot that is used for new association type status on update associations */
249     public static final String SLOT_NAME_NEW_STATUS = "NewStatus";
250 
251     /** Name of the slot that is used for document availability on document entries */
252     public static final String SLOT_NAME_DOCUMENT_AVAILABILITY = "documentAvailability";
253 
254     /** Annotation for association propagation*/
255     public static final String SLOT_NAME_ASSOCIATION_PROPAGATION = "AssociationPropagation";
256 
257     /** Name of the slot that is used for reference ID list */
258     public static final String SLOT_NAME_REFERENCE_ID_LIST = "urn:ihe:iti:xds:2013:referenceIdList";
259 
260     /** Name of the slot that is used for reference ID list */
261     public static final String SLOT_NAME_HOME_COMMUNITY_ID = "homeCommunityId";
262 
263 
264 
265     /** Universal ID Type to be used for all HD data types used with XDS */
266     public static final String UNIVERSAL_ID_TYPE_OID = "ISO";
267 
268     
269     
270     /** Node representation for the author classification */
271     public static final String NODE_REPRESENTATION_AUTHOR = "";
272     
273     /** Node representation for the class code classification */
274     public static final String NODE_REPRESENTATION_CLASSCODE = "classCode";    
275 
276     /** Node representation for the class code classification */
277     public static final String NODE_REPRESENTATION_CONFIDENTIALITY_CODE = "confidentialityCode";
278 }