class: searchKeyword

public class: searchKeyword
Author:
Project: Phase: 1.0; Status: Proposed; Version: 1.0; Complexity: 1
Dates: Created: 19/01/2006 10:41:26; Modified: 10/04/2006 13:31:53;
Flags: Active: false; IsRoot: false; IsLeaf: false;
Extension Points:
UUID: {5A9784E8-F932-47c1-8DE8-43996E6594DD}
A search keyword is an optional method of searching for services. A search keyword can be used in isolation from or combined with other optional search criteria. More than one search keyword can be supplied.

A search keyword can be either free text or a coded value from a coding schema such as SNOMED, accompanied by the textual representation of this value.

A single search keyword can exist independently of a searchKeywordOperator. Where multiple searchKeywords exist they must be related via a set of searchKeywordOperators.
 

Goto: Custom Properties, Fields

See also: searchKeywordOperator, searchCriteria

Appears in: Communication Description, Choose and Book Referral Status

Connections
 
Custom Properties
 
searchKeyword Attributes
Attribute Details
public int
  codeValue
Range:0 to 1
Notes: The code value of the keyword. If a code value is provided then the keywordText should be the textual representation of the code value as defined by the coding schema.
public string
  codingSchema
Range:0 to 1
Notes: An identifier of the coding schema used for the keyword. E.g. SnomedCT or Read. A keyword could also be free text entered by the user or specified from a standard list maintained by Choose and Book. In the case of free text then no coding schema would be specified.

If a coding schema is specified, the a code value must also be provided.
public int
  contextualModifier
Range:0 to 1
Notes: A modifier for the codeValue. This will be an external list of values maintained by Choose and Book.
public string
  keywordText
Notes: The text of the keyword. Either free text or if a code value is provided then this text should be the textual representation of the code value as defined by the coding schema.