Cancer Outcomes and Services Data Set (COSD)

Data Types

NOTE: This page is intended to provide an abstract view on the underlying data types schema used by the dataset. Accordingly, certain details of specific elements and attributes may be omitted for reasons of brevity. Any data types referenced within the "xs:" namespace represent those defined within the XML Schema language. For further information on these data types please consult XML Schema documentation.

AD

The data type supports the representation of an address.

Extends: ANY

ElementTypeminOccursmaxOccurs
Choice of: 0unbounded
delimiterADXP
countryADXP
stateADXP
countyADXP
cityADXP
postalCodeADXP
streetAddressLineADXP
houseNumberADXP
houseNumberNumericADXP
directionADXP
streetNameADXP
streetNameBaseADXP
streetNameTypeADXP
additionalLocatorADXP
unitIDADXP
unitTypeADXP
carrierADXP
censusTractADXP
addressKeysee schema
descsee schema
useablePeriodIVL_TS0unbounded
idII01
AttributeTypeUsage
useset_cs_PostalAddressUseoptional
isNotOrderedbloptional

AD.GB-en-NHS.AddressType1

This data type supports the representation of an address represented with a postcode attribute.

Extends: ANY

ElementTypeminOccursmaxOccurs
postalCodepostal_type11

AD.GB-en-NHS.AddressType4

This data type supports the representation of a structured or unstructured address.

ElementTypeminOccursmaxOccurs
postalCodeADXP00
Choice of:
UnstructuredAddresssee schema
StructuredAddresssee schema

AD.NHS.AddressType1

This data type supports the representation of an address

Restricts: AD.NHS.Internal

ElementTypeminOccursmaxOccurs
postalCodeADXP11
streetAddressLineADXP00
AttributeTypeUsage
nullFlavorcs_NullFlavorprohibited
updateModecs_UpdateModeprohibited
useset_cs_PostalAddressUseprohibited

AD.NHS.Internal

This data type supports the representation of an address.

Extends: ANY

ElementTypeminOccursmaxOccurs
postalCodeADXP01
streetAddressLineADXP05
AttributeTypeUsage
useset_cs_PostalAddressUseoptional

ADXP

This data type supports the representation of an address part.

Extends: ST

AttributeTypeUsage
partTypecs_AddressPartTypeoptional

ANY

This data type represents an abstract type from which more specific data types are derived.

bin

This data type supports the representation of Base64-encoded data.

Constrains values permitted by: xs:base64Binary

BIN

This data type supports the representation of binary data.

Extends: ANY

AttributeTypeUsage
representationcs_BinaryDataEncodingoptional

bl

This data type supports the representation of a binary value.

Constrains values permitted by: xs:boolean

Restriction TypeDetail
Value Patterntrue|false

BL

This data type supports the representation of a boolean "value", which shall be "true" or "false".

Extends: ANY

AttributeTypeUsage
valuebloptional

CD

This data type supports the representation of a concept descriptor.

Extends: ANY

ElementTypeminOccursmaxOccurs
originalTextED01
qualifierCR0unbounded
groupsee schema
translationCD0unbounded
AttributeTypeUsage
codecsoptional
codeSystemuidoptional
codeSystemNamestoptional
codeSystemVersionstoptional
displayNamestoptional

CE

This data type supports the representation of coded data, where the approved coding scheme is not the original scheme in which the data was encoded.

Restricts: CD

ElementTypeminOccursmaxOccurs
qualifierCR00
originalTextED01
translationCD0unbounded
AttributeTypeUsage
codecsoptional
codeSystemuidoptional
codeSystemNamestoptional
codeSystemVersionstoptional
displayNamestoptional

CR

Extends: CD

ElementTypeminOccursmaxOccurs
nameCV01
valueCD01
AttributeTypeUsage
invertedbloptional

cs

This data type supports the representation of a character string.

Constrains values permitted by: xs:token

Restriction TypeDetail
Value Pattern[^\s]*

cs_AddressPartType

This data type supports the representation of a specific part of an address.

Constrains values permitted by: cs

Restriction TypeDetail
Permitted values
  • DEL
  • CNT
  • STA
  • CPA
  • CTY
  • ZIP
  • SAL
  • BNR
  • BNN
  • DIR
  • STR
  • STB
  • STTYP
  • ADL
  • UNID
  • UNIT
  • CAR
  • CEN
  • DESC
  • ADDRK

cs_BinaryDataEncoding

This data type supports the representation of the encoding type used for binary data.

Constrains values permitted by: xs:NMTOKEN

Restriction TypeDetail
Permitted values
  • B64
  • TXT

cs_CompressionAlgorithm

This data type supports the representation of the algorithm used to compress data.

Constrains values permitted by: cs

Restriction TypeDetail
Permitted values
  • DF
  • GZ
  • ZL
  • Z

cs_EntityNamePartQualifier

This data type supports the representation of an entity name part qualifier.

Constrains values permitted by: cs

Restriction TypeDetail
Permitted values
  • BR
  • SP
  • VV
  • AC
  • PR
  • NB
  • LS
  • CL
  • IN

cs_EntityNamePartType

This data type supports the representation of an entity name part type.

Constrains values permitted by: cs

Restriction TypeDetail
Permitted values
  • FAM
  • GIV
  • PFX
  • SFX
  • DEL

cs_EntityNameUse

This data type supports the representation of a specific use of an entity name.

Constrains values permitted by: cs

Restriction TypeDetail
Permitted values
  • L
  • A
  • I
  • R
  • ABC
  • SYL
  • IDE
  • PREVIOUS-BIRTH
  • PREVIOUS-MAIDEN
  • PREVIOUS-BACHELOR
  • PREVIOUS
  • PREFERRED

cs_IntegrityCheckAlgorithm

This data type supports the representation of an algorithm used to check the integrity of data.

Constrains values permitted by: cs

Restriction TypeDetail
Permitted values
  • SHA-1
  • SHA-256

cs_NullFlavor

This data type supports the representation of the null flavour used.

Constrains values permitted by: cs

Restriction TypeDetail
Permitted values
  • NI
  • NA
  • UNK
  • NASK
  • ASKU
  • NAV
  • OTH
  • PINF
  • NINF

cs_PostalAddressUse

This data type supports the representation of the specific usage of a postal address.

Constrains values permitted by: cs

Restriction TypeDetail
Permitted values
  • PHYS
  • PST
  • TMP
  • BAD
  • H
  • HP
  • HV
  • WP
  • ABC
  • SYL
  • IDE

cs_SetOperator

This data type supports the representation of a set operator.

Constrains values permitted by: cs

Restriction TypeDetail
Permitted values
  • I
  • E
  • A
  • H
  • P

cs_TelecommunicationAddressUse

This data type supports the representation of telecommunication address use.

Constrains values permitted by: cs

Restriction TypeDetail
Permitted values
  • H
  • HP
  • HV
  • WP
  • AS
  • EC
  • PG
  • MC

cs_UpdateMode

This data type supports the representation of the update mode used for data.

Constrains values permitted by: cs

Restriction TypeDetail
Permitted values
  • added
  • altered
  • removed
  • unchanged

CV

This data type supports the representation of coded data where there is no requirement from sending translations or qualifiers, otherwise it has the same structure as the CD data type.

Restricts: CE

ElementTypeminOccursmaxOccurs
originalTextED01
translationCD00
AttributeTypeUsage
codecsoptional
codeSystemuidoptional
codeSystemNamestoptional
codeSystemVersionstoptional
displayNamestoptional

CV.GB-en-NHS.CodedValueType1

This data type supports the representation of a code only.

Restricts: CV

AttributeTypeUsage
codeSystemNamestprohibited
codeSystemVersionstprohibited
displayNamestprohibited
codecsrequired
codeSystemuidprohibited

CV.GB-en-NHS.CodedValueType2

This data type supports the representation of NICIP content

Restricts: CV

AttributeTypeUsage
codeSystemNamestprohibited
codeSystemVersionstprohibited
displayNamestprohibited
codesee schemarequired
codeSystemuidprohibited

CV.GB-en-NHS.CodedValueType3

This type supports SNOMED-CT codes.

Restricts: CV

AttributeTypeUsage
codeSystemNamestprohibited
codeSystemVersionstprohibited
displayNamestprohibited
codesee schemarequired
codeSystemuidprohibited
nullFlavorcs_NullFlavorprohibited
updateModecs_UpdateModeprohibited

CV.GB-en-NHS.CodedValueType4

This data type supports the representation of value in the set: 'Y', 'N', 'X'.

Restricts: CV

AttributeTypeUsage
codeSystemNamestprohibited
codeSystemVersionstprohibited
displayNamestprohibited
codesee schemarequired
codeSystemuidprohibited

CV.GB-en-NHS.CodedValueType5

This data type supports the representation of ICDO content.

Restricts: CV

AttributeTypeUsage
codeSystemNamestprohibited
codeSystemVersionstprohibited
displayNamestprohibited
codesee schemarequired
codeSystemuidprohibited

CV.GB-en-NHS.CodedValueType6

This data type supports the representation of ICD10 content.

Restricts: CV

AttributeTypeUsage
codeSystemNamestprohibited
codeSystemVersionstprohibited
displayNamestprohibited
codesee schemarequired
codeSystemuidprohibited

CV.GB-en-NHS.CodedValueType7

This data type supports the representation of OPCS coding.

Restricts: CV

AttributeTypeUsage
codeSystemNamestprohibited
codeSystemVersionstprohibited
displayNamestprohibited
codesee schemarequired
codeSystemuidprohibited

CV.GB-en-NHS.CodedValueType8

This data type supports the representation of Ethnic Category Code.

Restricts: CV

AttributeTypeUsage
codeSystemNamestprohibited
codeSystemVersionstprohibited
displayNamestprohibited
codesee schemarequired
codeSystemuidprohibited

CV.GB-en-NHS.CodedValueType9

This data type supports the representation of SNOMED content (of any version).

Restricts: CV

AttributeTypeUsage
codeSystemNamestprohibited
codeSystemVersionstprohibited
displayNamestprohibited
codesee schemarequired
codeSystemuidprohibited
nullFlavorcs_NullFlavorprohibited
updateModecs_UpdateModeprohibited

ED

This data type supports the representation of encapsulated data.

Extends: BIN

ElementTypeminOccursmaxOccurs
referenceTEL01
thumbnailthumbnail01
n/aany element0unbounded
AttributeTypeUsage
mediaTypecsoptional
languagecsoptional
compressioncs_CompressionAlgorithmoptional
integrityCheckbinoptional
integrityCheckAlgorithmcs_IntegrityCheckAlgorithmoptional

EN

This data type supports the representation of an entity name.

Extends: ANY

ElementTypeminOccursmaxOccurs
Choice of: 0unbounded
delimiteren.delimiter
familyen.family
givenen.given
prefixen.prefix
suffixen.suffix
validTimeIVL_TS01
idII01
AttributeTypeUsage
useset_cs_EntityNameUseoptional

en.delimiter

This data type supports the representation of a delimiter.

Restricts: ENXP

AttributeTypeUsage
partTypecs_EntityNamePartTypeoptional

en.family

This data type supports the representation of entity's family name.

Restricts: ENXP

AttributeTypeUsage
partTypecs_EntityNamePartTypeoptional

en.given

This data type supports the representation of entity's given name.

Restricts: ENXP

AttributeTypeUsage
partTypecs_EntityNamePartTypeoptional

en.prefix

This data type supports the representation of entity's prefix.

Restricts: ENXP

AttributeTypeUsage
partTypecs_EntityNamePartTypeoptional

en.suffix

This data type supports the representation of entity's suffix.

Restricts: ENXP

AttributeTypeUsage
partTypecs_EntityNamePartTypeoptional

ENXP

This data type supports the representation of part of an entity name.

Extends: ST

AttributeTypeUsage
partTypecs_EntityNamePartTypeoptional
qualifierset_cs_EntityNamePartQualifieroptional

II

This data type supports the representation of an instance identifier.

Extends: ANY

AttributeTypeUsage
rootuidoptional
extensionstoptional
assigningAuthorityNamestoptional
displayablebloptional

II.GB-en-NHS.IdentifierType2

This data type supports the sending of DCE UUID

Restricts: II.NPfIT.uuid.required

AttributeTypeUsage
rootII.NPfIT.root.uuidrequired
extensionstprohibited
nullFlavorcs_NullFlavorprohibited

II.GB-en-NHS.IdentifierType4

This data type supports the sending of Organisation data as derived from ODS.

Restricts: II

AttributeTypeUsage
rootuidprohibited
extensionsee schemarequired
assigningAuthorityNamestprohibited
displayableblprohibited

II.GB-en-NHS.IdentifierType5

This data type supports the use of NHS Number content

Restricts: II

AttributeTypeUsage
rootuidprohibited
extensionsee schemarequired
assigningAuthorityNamestprohibited
displayableblprohibited

II.GB-en-NHS.IdentifierType6

This data type supports the use of Radiological Accession Number content.

Restricts: II

AttributeTypeUsage
rootuidprohibited
extensionsee schemarequired
assigningAuthorityNamestprohibited
displayableblprohibited

II.GB-en-NHS.IdentifierType7

This data type supports the representation of a referrer code.

Restricts: II

AttributeTypeUsage
rootuidprohibited
extensionsee schemarequired
assigningAuthorityNamestprohibited
displayableblprohibited

II.NPfIT.root.uuid

This data type supports the representation of a UUID.

Constrains values permitted by: uid

Restriction TypeDetail
Value Pattern[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}

II.NPfIT.uuid.required

This data type supports the representation of a UUID.

Restricts: II

AttributeTypeUsage
rootII.NPfIT.root.uuidoptional
extensionstprohibited
nullFlavorcs_NullFlavoroptional
updateModecs_UpdateModeprohibited
assigningAuthorityNamestprohibited
displayableblprohibited

int

This data type supports the representation of an integer number.

Constrains values permitted by: xs:integer

INT

This data type supports the representation of an integer expressed as an attribute "value".

Extends: QTY

AttributeTypeUsage
valueintoptional

IVL_TS

This data type supports the representation of a time interval.

Extends: SXCM_TS

IVXB_TS

Extends: TS

AttributeTypeUsage
inclusivebloptional

oid

This data type supports the representation of an object identifier.

Constrains values permitted by: xs:string

Restriction TypeDetail
Value Pattern([0-9][0-9]*)(\.[0-9][0-9]*)*

PN

This data type supports the representation of a person name.

Extends: EN

PN.GB-en-NHS.PersonNameType4

This data type supports the representation of a family name.

ElementTypeminOccursmaxOccurs
prefixen.prefix00
givenen.given00
familysee schema

PN.GB-en-NHS.PersonNameType5

This data type supports the representation of a given name.

ElementTypeminOccursmaxOccurs
prefixen.prefix00
givensee schema
familyen.family00

PN.NHS.Internal

This data type supports the representation of a name of the form: {prefix} {given} {given} {family}.

Extends: ANY

ElementTypeminOccursmaxOccurs
prefixen.prefix01
givenen.given02
familyen.family01
AttributeTypeUsage
useset_cs_EntityNameUseoptional

postal_type

This data type supports the representation of a postal code.

Constrains values permitted by: xs:string

Restriction TypeDetail
Maximum Value Length8

postalCodeType

This data type supports the representation of a postal code.

Constrains values permitted by: xs:string

Restriction TypeDetail
Maximum Value Length8

PQ

This data type supports the representation of a physical quantity.

Extends: QTY

ElementTypeminOccursmaxOccurs
translationPQR0unbounded
AttributeTypeUsage
valuerealoptional
unitcsoptional

PQR

This data type supports the representation of physical quantity ratios.

Extends: CV

AttributeTypeUsage
valuerealoptional

QTY

This data type supports the representation of a quantity.

Extends: ANY

real

This data type supports the representation of a quantity defined at a given point of a continuum.

Permits any value from: xs:decimal xs:double

REAL

This data type supports the representation of fractional numbers.

Extends: QTY

AttributeTypeUsage
valuerealoptional

ruid

This data type supports the representation of an identifier.

Constrains values permitted by: xs:string

Restriction TypeDetail
Value Pattern[A-Za-z][A-Za-z0-9\-]*

set_cs_EntityNamePartQualifier

This data type supports the representation of a set of entity name part qualifiers.

Permits a list of items from: cs_EntityNamePartQualifier

set_cs_EntityNameUse

This data type supports the representation of a set of entity name uses.

Permits a list of items from: cs_EntityNameUse

set_cs_PostalAddressUse

This data type supports the representation of a set of postal address uses.

Permits a list of items from: cs_PostalAddressUse

set_cs_TelecommunicationAddressUse

This data type supports the representation of a set of telecommunication address uses.

Permits a list of items from: cs_TelecommunicationAddressUse

st

This data type supports the representation of a string of characters.

Constrains values permitted by: xs:string

ST

This data type supports the representation of string data.

Restricts: ED

ElementTypeminOccursmaxOccurs
referenceTEL01
thumbnailthumbnail01
n/aany element0unbounded
AttributeTypeUsage
mediaTypecsoptional
languagecsoptional
compressioncs_CompressionAlgorithmoptional
integrityCheckbinoptional
integrityCheckAlgorithmcs_IntegrityCheckAlgorithmoptional

ST.GB-en-NHS.StringType1

This data type supports the representation of dictionary dates.

Constrains values permitted by: st

Restriction TypeDetail
Value Pattern(19|20)\d\d-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ST.GB-en-NHS.StringType2

This data type supports the representation of a boolean with value 'Y' or 'N'.

Constrains values permitted by: st

Restriction TypeDetail
Permitted values
  • Y
  • N

ST.GB-en-NHS.StringType3

This data type supports the representation of an alphanumeric string.

Constrains values permitted by: st

Restriction TypeDetail
Value Pattern[a-zA-Z0-9]*

SXCM_TS

Extends: TS

AttributeTypeUsage
operatorcs_SetOperatoroptional

TEL

This data type supports the representation of telephone numbers, pager and email addresses, and references to external data.

Extends: URL

ElementTypeminOccursmaxOccurs
useablePeriodIVL_TS0unbounded
idII01
AttributeTypeUsage
useset_cs_TelecommunicationAddressUseoptional

thumbnail

This data type supports the representation of a thumbnail image.

Restricts: ED

ElementTypeminOccursmaxOccurs
referenceTEL01
thumbnailthumbnail00
n/aany element0unbounded

ts

This data type supports the representation of a timestamp.

Constrains values permitted by: xs:string

Restriction TypeDetail
Value Pattern[0-9]{1,8}|([0-9]{9,14}|[0-9]{14,14}\.[0-9]+)([+\-][0-9]{1,4})?

TS

This data type supports the representation of a timeStamp.

Extends: QTY

AttributeTypeUsage
valuetsoptional

TS.GB-en-NHS.Date

This data type supports the representation of a date of the form: yyyy-mm-dd.

Restricts: TS

AttributeTypeUsage
valuesee schemarequired

uid

This data type supports the representation of a unique identifier.

Permits any value from: oid uuid ruid

url

This data type supports the representation of a Uniform Resource Locator (URL).

Constrains values permitted by: xs:anyURI

Restriction TypeDetail
Value Pattern[\-a-z0-9+]+:.*

URL

This data type supports the representation of a Uniform Resource Locator (URL).

Extends: ANY

AttributeTypeUsage
valueurloptional

uuid

This data type supports the representation of a Universally Unique Identifier (UUID).

Constrains values permitted by: xs:string

Restriction TypeDetail
Value Pattern[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}