Commit c7e2c067 authored by Tony Schaller's avatar Tony Schaller

First raw draft for value set handling

git-svn-id: https://svn.code.sf.net/p/ehealthconnector/code/trunk@1724 e99adb7c-5e35-42fd-8d1b-cdb378af05e8
parent bb8941ae
/*
* The authorship of this project and accompanying materials is held by medshare GmbH, Switzerland.
* All rights reserved. https://medshare.net
*
* Source code, documentation and other resources have been contributed by various people.
* Project Team: https://sourceforge.net/p/ehealthconnector/wiki/Team/
* For exact developer information, please refer to the commit history of the forge.
*
* This code is made available under the terms of the Eclipse Public License v1.0.
*
* Accompanying materials are made available under the terms of the Creative Commons
* Attribution-ShareAlike 4.0 License.
*
* This line is intended for UTF-8 encoding checks, do not modify/delete: äöüéè
*
*/
package org.ehealth_connector.demo.valueset;
public class DemoValueSet {
public void doDemo() {
// TODO
}
}
/*
* The authorship of this project and accompanying materials is held by medshare GmbH, Switzerland.
* All rights reserved. https://medshare.net
*
* Source code, documentation and other resources have been contributed by various people.
* Project Team: https://sourceforge.net/p/ehealthconnector/wiki/Team/
* For exact developer information, please refer to the commit history of the forge.
*
* This code is made available under the terms of the Eclipse Public License v1.0.
*
* Accompanying materials are made available under the terms of the Creative Commons
* Attribution-ShareAlike 4.0 License.
*
* This line is intended for UTF-8 encoding checks, do not modify/delete: äöüéè
*
*/
package org.ehealth_connector.common.basetypes;
import org.ehealth_connector.common.enums.AddressUse;
/**
* Java Prototype for Value Set Management Concept.
*
* Source: ART-DECOR CDA-CH Address Information Compilation - eCH-0010
*/
public interface AddressBaseType {
public String getAdditionalLocator();
public String getCity();
public String getCountry();
public String getHouseNumber();
public String getPostalCode();
public String getPostBox();
public String getState();
public String getStreetAddressLine1();
public String getStreetAddressLine2();
public AddressUse getUsage();
/**
* Sets the additional locator.
*
* Number of addressed apartment. This is occasionally necessary for larger
* buildings. With a maximum length of 30 characters. eCH-0010 V7.0
* addressInformation
*
* @param value
* the new additional locator
*/
public void setAdditionalLocator(String value);
/**
* Sets the city.
*
* Addressed city (in foreign addresses if necessary including province,
* etc.). When using the information according to the Swiss Post, the
* 27-digit city name must be used. eCH-0010 V7.0 addressInformation
*
*
*
* @param value
* the new city
*/
public void setCity(String value);
/**
* Sets the country.
*
* Two-digit, alphanumeric ISO country code according to [ISO 3166-1] of the
* country in which the address is located. The country defines the
* conventions for addressing. The country code MUST also be declared for
* Swiss postal addresses. Caution: Political changes or renaming of
* countries will result in adjustments to the ISO country list. The length
* of the feature is 2 characters. eCH-0010 V7.0 addressInformation
*
*
* @param value
* the new country
*/
public void setCountry(String value);
/**
* Sets the house number.
*
* House number in postal addresses (including house number additives). With
* a maximum length of 30 characters. eCH-0010 V7.0 addressInformation
*
* @param value
* the new house number
*/
public void setHouseNumber(String value);
/**
* Sets the postal code.
*
* Postal code given by Swiss Post or postal code issued by a post office
* abroad, that can consist of numbers, letters or a combination of both,
* possibly even special characters. eCH-0010 V7.0 addressInformation
*
*
* @param value
* the new postal code
*/
public void setPostalCode(String value);
/**
* Sets the post box.
*
* Number of the addressed post box in a maximum length of 8 characters.
* eCH-0010 V7.0 addressInformation
*
*
* @param value
* the new post box
*/
public void setPostBox(String value);
/**
* Sets the state.
*
* Occasionally, additional geographic information must be provided in
* foreign addresses, in addition to city and country. This element can be
* used for such cases. It contains superordinate or subordinate information
* on a city, such as region, province, state or local district. Since it is
* difficult - especially with foreign addresses - to determine whether an
* indication is subordinate or subordinate, a separate mapping of
* superordinate and subordinate indication is omitted. eCH-0010 V7.0
* addressInformation
*
*
* @param value
* the new state
*/
public void setState(String value);
/**
* Sets the street address line 1.
*
* Free additional lines for additional address information which can not be
* used in the other address fields (e.g. for c/o entries, etc.), with a
* maximum length of 150 characters. addressLine1 should be used for
* personalized addressing (e.g., c/o-Address). eCH-0010 V7.0
* addressInformation
*
* @param value
* the new street address line 1
*/
public void setStreetAddressLine1(String value);
/**
* Sets the street address line 2.
*
* Free additional lines for additional address information which can not be
* used in the other address fields (e.g. for c/o entries, etc.), with a
* maximum length of 150 characters. addressLine2 should be used for
* non-personalized address details (e.g., additional location information,
* e.g. "Chalet Edelweiss"). eCH-0010 V7.0 addressInformation
*
* @param value
* the new street address line 2
*/
public void setStreetAddressLine2(String value);
/**
* Sets the street name.
*
* Street names in postal addresses. It can also be the name of a locality,
* a hamlet, etc. With a maximum length of 150 characters. eCH-0010 V7.0
* addressInformation
*
*
* @param value
* the new street name
*/
public void setStreetName(String value);
public void setUsage(AddressUse value);
}
/*
* The authorship of this project and accompanying materials is held by medshare GmbH, Switzerland.
* All rights reserved. https://medshare.net
*
* Source code, documentation and other resources have been contributed by various people.
* Project Team: https://sourceforge.net/p/ehealthconnector/wiki/Team/
* For exact developer information, please refer to the commit history of the forge.
*
* This code is made available under the terms of the Eclipse Public License v1.0.
*
* Accompanying materials are made available under the terms of the Creative Commons
* Attribution-ShareAlike 4.0 License.
*
* This line is intended for UTF-8 encoding checks, do not modify/delete: äöüéè
*
*/
package org.ehealth_connector.common.basetypes;
/**
* Java Prototype for Value Set Management Concept.
*/
public interface AddressBaseTypeBuilder {
public AddressBaseTypeBuilder additionalLocator(String value);
public AddressBaseTypeBuilder city(String value);
public AddressBaseTypeBuilder country(String value);
public AddressBaseType createAddressBaseType();
public AddressBaseTypeBuilder houseNumber(String value);
public AddressBaseTypeBuilder postalCode(String value);
public AddressBaseTypeBuilder postBox(String value);
public AddressBaseTypeBuilder state(String value);
public AddressBaseTypeBuilder streetAddressLine1(String value);
public AddressBaseTypeBuilder streetAddressLine2(String value);
public AddressBaseTypeBuilder usage(String value);
}
/*
* The authorship of this project and accompanying materials is held by medshare GmbH, Switzerland.
* All rights reserved. https://medshare.net
*
* Source code, documentation and other resources have been contributed by various people.
* Project Team: https://sourceforge.net/p/ehealthconnector/wiki/Team/
* For exact developer information, please refer to the commit history of the forge.
*
* This code is made available under the terms of the Eclipse Public License v1.0.
*
* Accompanying materials are made available under the terms of the Creative Commons
* Attribution-ShareAlike 4.0 License.
*
* This line is intended for UTF-8 encoding checks, do not modify/delete: äöüéè
*
*/
package org.ehealth_connector.common.basetypes;
import java.util.List;
import org.ehealth_connector.common.utils.LangText;
/**
* Java Prototype for Value Set Management Concept.
*
* A concept descriptor represents any kind of concept usually by giving a code
* defined in a code system. A concept descriptor can contain the original text
* or phrase that served as the basis of the coding and one or more translations
* into different coding systems. A concept descriptor can also contain
* qualifiers to describe, e.g., the concept of a "left foot" as a
* postcoordinated term built from the primary code "FOOT" and the qualifier
* "LEFT". In exceptional cases, the concept descriptor need not contain a code
* but only the original text describing that concept.
*
*/
public interface CodeBaseType {
/**
* Adds the code translation.
*
* A set of other concept descriptors that translate this concept descriptor
* into other code systems.
*
* @param code
* the code
*/
public void addCodeTranslation(CodeBaseType value);
public void addDisplayNameTranslation(LangText value);
public String getCode();
public String getCodeSystem();
public String getCodeSystemName();
public String getDisplayName();
public String getOriginalText();
public List<CodeBaseType> listCodeTranslations();
public List<LangText> listDisplayNameTranslations();
/**
* Sets the code.
*
* The plain code symbol defined by the code system. For example, "784.0" is
* the code symbol of the ICD-9 code "784.0" for headache.
*
* @param code
* the new code
*/
public void setCode(String value);
/**
* Sets the code system.
*
* Specifies the code system that defines the code.
*
* @param codeSystem
* the new code system
*/
public void setCodeSystem(String value);
/**
* Sets the code system name.
*
* A common name of the coding system.
*
* @param codeSystemName
* the new code system name
*/
public void setCodeSystemName(String value);
/**
* Sets the display name.
*
* A name or title for the code, under which the sending system shows the
* code value to its users.
*
* @param displayName
* the new display name
*/
public void setDisplayName(String value);
/**
* Sets the original text.
*
* The text or phrase used as the basis for the coding.
*
* @param originalText
* the new original text
*/
public void setOriginalText(String value);
/*
* Im Schema steht noch:
*
* qualifier: Specifies additional codes that increase the specificity of
* the primary code.
*
* codeSystemVersion: If applicable, a version descriptor defined
* specifically for the given code system.
*/
}
/*
* The authorship of this project and accompanying materials is held by medshare GmbH, Switzerland.
* All rights reserved. https://medshare.net
*
* Source code, documentation and other resources have been contributed by various people.
* Project Team: https://sourceforge.net/p/ehealthconnector/wiki/Team/
* For exact developer information, please refer to the commit history of the forge.
*
* This code is made available under the terms of the Eclipse Public License v1.0.
*
* Accompanying materials are made available under the terms of the Creative Commons
* Attribution-ShareAlike 4.0 License.
*
* This line is intended for UTF-8 encoding checks, do not modify/delete: äöüéè
*
*/
package org.ehealth_connector.common.basetypes;
import org.ehealth_connector.common.utils.LangText;
/**
* Java Prototype for Value Set Management Concept.
*/
public interface CodeBaseTypeBuilder {
public CodeBaseTypeBuilder addCodeTranslation(CodeBaseType value);
public CodeBaseTypeBuilder addDisplayNameTranslation(LangText value);
public CodeBaseTypeBuilder code(String value);
public CodeBaseTypeBuilder codeSystem(String value);
public CodeBaseTypeBuilder codeSystemName(String value);
public CodeBaseType createCodeBaseType();
public CodeBaseTypeBuilder displayName(String value);
public CodeBaseTypeBuilder originalText(String value);
}
/*
* The authorship of this project and accompanying materials is held by medshare GmbH, Switzerland.
* All rights reserved. https://medshare.net
*
* Source code, documentation and other resources have been contributed by various people.
* Project Team: https://sourceforge.net/p/ehealthconnector/wiki/Team/
* For exact developer information, please refer to the commit history of the forge.
*
* This code is made available under the terms of the Eclipse Public License v1.0.
*
* Accompanying materials are made available under the terms of the Creative Commons
* Attribution-ShareAlike 4.0 License.
*
* This line is intended for UTF-8 encoding checks, do not modify/delete: äöüéè
*
*/
package org.ehealth_connector.common.basetypes;
// TODO: Auto-generated Javadoc
/**
* Java Prototype for Value Set Management Concept.
*
* An identifier that uniquely identifies a thing or object. Examples are object
* identifier for HL7 RIM objects, medical record number, order id, service
* catalog item id, Vehicle Identification Number (VIN), etc. Instance
* identifiers are defined based on ISO object identifiers.
*
*/
public interface IdentificatorBaseType {
/**
* Gets the assigning authority name.
*
* @return the assigning authority name
*/
public String getAssigningAuthorityName();
/**
* Gets the extension.
*
* @return the extension
*/
public String getExtension();
/**
* Gets the root.
*
* @return the root
*/
public String getRoot();
/**
* Sets the assigning authority name. A human readable name or mnemonic for
* the assigning authority. This name may be provided solely for the
* convenience of unaided humans interpreting an II value and can have no
* computational meaning. Note: no automated processing must depend on the
* assigning authority name to be present in any form.
*
* @param name
* the new assigning authority name
*/
public void setAssigningAuthorityName(String value);
/**
* Sets the displayable. Specifies if the identifier is intended for human
* display and data entry (displayable = true) as opposed to pure machine
* interoperation (displayable = false).
*
* @param displayable
* the new displayable
*/
public void setDisplayable(boolean value);
public boolean getDisplayable();
/**
* Sets the extension. A character string as a unique identifier within the
* scope of the identifier root.
*
* @param extension
* the new extension
*/
public void setExtension(String value);
/**
* Sets the root. A unique identifier that guarantees the global uniqueness
* of the instance identifier. The root alone may be the entire instance
* identifier.
*
* @param root
* the new root
*/
public void setRoot(String value);
}
/*
* The authorship of this project and accompanying materials is held by medshare GmbH, Switzerland.
* All rights reserved. https://medshare.net
*
* Source code, documentation and other resources have been contributed by various people.
* Project Team: https://sourceforge.net/p/ehealthconnector/wiki/Team/
* For exact developer information, please refer to the commit history of the forge.
*
* This code is made available under the terms of the Eclipse Public License v1.0.
*
* Accompanying materials are made available under the terms of the Creative Commons
* Attribution-ShareAlike 4.0 License.
*
* This line is intended for UTF-8 encoding checks, do not modify/delete: äöüéè
*
*/
package org.ehealth_connector.common.basetypes;
/**
* Java Prototype for Value Set Management Concept.
*/
public interface IdentificatorBaseTypeBuilder {
public IdentificatorBaseTypeBuilder assigningAuthorityName(String value);
public IdentificatorBaseType createIdentificatorBaseType();
public IdentificatorBaseTypeBuilder displayable(boolean value);
public IdentificatorBaseTypeBuilder extension(String value);
public IdentificatorBaseTypeBuilder root(String value);
}
/*
* The authorship of this project and accompanying materials is held by medshare GmbH, Switzerland.
* All rights reserved. https://medshare.net
*
* Source code, documentation and other resources have been contributed by various people.
* Project Team: https://sourceforge.net/p/ehealthconnector/wiki/Team/
* For exact developer information, please refer to the commit history of the forge.
*
* This code is made available under the terms of the Eclipse Public License v1.0.
*
* Accompanying materials are made available under the terms of the Creative Commons
* Attribution-ShareAlike 4.0 License.
*
* This line is intended for UTF-8 encoding checks, do not modify/delete: äöüéè
*
*/
package org.ehealth_connector.common.basetypes;
import java.util.List;
import org.ehealth_connector.common.Identificator;
/**
* Java Prototype for Value Set Management Concept.
*/
public interface OrganizationBaseType {
public void addAddress(AddressBaseType value);
public void addIdentificator(Identificator value);
public void addName(String value);
public void addTelecom(TelecomBaseType value);
public AddressBaseType getPrimaryAddressBaseType();
public Identificator getPrimaryIdentificator();
public String getPrimaryName();
public TelecomBaseType getPrimaryTelecom();
public List<AddressBaseType> listAddresses();
public List<Identificator> listIdentificators();
public List<String> listNames();
public List<TelecomBaseType> listTelecoms();
public void setPrimaryAddress(AddressBaseType value);
public void setPrimaryIdentificator(Identificator value);
public void setPrimaryName(String value);
public void setPrimaryTelecom(TelecomBaseType value);
}
/*
* The authorship of this project and accompanying materials is held by medshare GmbH, Switzerland.
* All rights reserved. https://medshare.net
*
* Source code, documentation and other resources have been contributed by various people.