complexType PatientIdentity_General_Structure
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p569.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
children ns:WithheldIdentity_Structure ns:VerifiedIdentity_Structure ns:UnverifiedIdentity_Structure
used by
elements PersonGroupPatient_General_Structure/PatientIdentity_General_Structure PersonGroupPatient_Psychiatric_Structure/PatientIdentity_General_Structure PersonGroupPatient_AAndE_Structure/PatientIdentity_General_Structure PersonGroupPatient_CareActivity_Structure/PatientIdentity_General_Structure PersonGroupPatient_EAL_Structure/PatientIdentity_General_Structure
annotation
documentation
V6-1:
Structure Standardised for all Patients and Attributes rationalised.
The Human Fertilisation and Embryology Act 1990 as amended by the Human Fertilisation and Embryology (Disclosure of Information) Act 1992 imposes statutory restrictions on the disclosure of information about identifiable individuals in connection with certain infertility treatments.
A list of the relevant codes is given in the NHS Data Dictionary. 
In these cases the
LOCAL PATIENT IDENTIFIER,
NHS NUMBER, 
PATIENT NAME and ADDRESS,
POSTCODE OF USUAL ADDRESS and BIRTH DATE
must be omitted from the CDS.
source <xs:complexType name="PatientIdentity_General_Structure">
 
<xs:annotation>
   
<xs:documentation>V6-1:
Structure Standardised for all Patients and Attributes rationalised.
The Human Fertilisation and Embryology Act 1990 as amended by the Human Fertilisation and Embryology (Disclosure of Information) Act 1992 imposes statutory restrictions on the disclosure of information about identifiable individuals in connection with certain infertility treatments.
A list of the relevant codes is given in the NHS Data Dictionary. 
In these cases the
LOCAL PATIENT IDENTIFIER,
NHS NUMBER, 
PATIENT NAME and ADDRESS,
POSTCODE OF USUAL ADDRESS and BIRTH DATE
must be omitted from the CDS.
</xs:documentation>
 
</xs:annotation>
 
<xs:sequence>
   
<xs:choice>
     
<xs:element name="WithheldIdentity_Structure">
       
<xs:annotation>
         
<xs:documentation>V6-1:
XML Mandatory by choice
Must be first in sequence.
Reflects Status = 91 = Confidential

For patients with sensitive conditions (as defined in DSCN 41/98/P26), all patient identifiable information must be removed from Commissioning Data Set records.
This is indicated when the NHS Number Status Indicator has a code value = 91.

In these cases the
LOCAL PATIENT IDENTIFIER, ORGANISATION CODE (LOCAL PATIENT IDENTIFIER)
NHS NUMBER
PATIENT NAME
PERSON BIRTH DATE
should be omitted from the CDS Types.
</xs:documentation>
       
</xs:annotation>
       
<xs:complexType>
         
<xs:sequence>
           
<xs:sequence minOccurs="0" maxOccurs="0">
             
<xs:annotation>
               
<xs:documentation>Where this structure is used, both elements must be provided.</xs:documentation>
             
</xs:annotation>
             
<xs:element name="LocalPatientIdentifier" type="ns:LocalPatientIdentifier_Type" minOccurs="0" maxOccurs="0">
               
<xs:annotation>
                 
<xs:documentation>V6-1:
Data element moved into this structure to be controlled by the NHS Number Status Indicator XML Attribute.
</xs:documentation>
               
</xs:annotation>
             
</xs:element>
             
<xs:element name="OrganisationCode_LocalPatientIdentifier" type="ns:OrganisationCode_Type" minOccurs="0" maxOccurs="0">
               
<xs:annotation>
                 
<xs:documentation>V6-1:
Data element moved into this structure to be controlled by the NHS Number Status Indicator XML Attribute.
</xs:documentation>
               
</xs:annotation>
             
</xs:element>
           
</xs:sequence>
           
<xs:element name="NHSNumber" type="ns:NHSNumber_Type" minOccurs="0" maxOccurs="0"/>
           
<xs:element name="NHSNumberStatusIndicator" type="ns:NHSNumberStatusIndicator_Withheld_Type">
             
<xs:annotation>
               
<xs:documentation>V6-1:
XML Mandatory if this data structure is used
Uses "Withheld_Type" with a value of 91
</xs:documentation>
             
</xs:annotation>
           
</xs:element>
           
<xs:element name="PatientName" type="ns:PersonName_Structure" minOccurs="0" maxOccurs="0"/>
           
<xs:element name="PatientUsualAddress" type="ns:Address_Structure" minOccurs="0" maxOccurs="0"/>
           
<xs:element name="PostcodeOfUsualAddress" type="ns:PostcodeOfUsualAddress_Type" minOccurs="0" maxOccurs="0"/>
           
<xs:element name="OrganisationCode_PCTOfResidence" type="ns:PCT_Code_Type" minOccurs="0"/>
           
<xs:element name="PersonBirthDate" type="ns:PersonBirthDate_Type" minOccurs="0" maxOccurs="0">
             
<xs:annotation>
               
<xs:documentation>V6-1 Data Element moved into this structure to be controlled by the NHS Number Status Indicator Attribute. </xs:documentation>
             
</xs:annotation>
           
</xs:element>
         
</xs:sequence>
         
<xs:attribute name="NHSNumberStatusIndicator" type="ns:NHSNumberStatusIndicator_Withheld_Type" use="required">
           
<xs:annotation>
             
<xs:documentation>V6-1:
Only Code Value = 91 is acceptable

Uses the "Withheld_Type" with a value of 91 for the XML Attribute
</xs:documentation>
           
</xs:annotation>
         
</xs:attribute>
       
</xs:complexType>
     
</xs:element>
     
<xs:element name="VerifiedIdentity_Structure">
       
<xs:annotation>
         
<xs:documentation>V6-1:
XML Mandatory by choice.
AttributeReflects Status= 01= Verified.

If the NHS Number has been Verified - it must also be Valid with the correct format and Modulus 11 Check Digit.  The schema does not check "validity".

For reasons of confidentiality, the patient's NAMEand ADDRESS (not including POSTCODE OF USUAL ADDRESS) must NOT be carried where a valid NHS Number is present.

</xs:documentation>
       
</xs:annotation>
       
<xs:complexType>
         
<xs:sequence>
           
<xs:sequence minOccurs="0">
             
<xs:annotation>
               
<xs:documentation>Where this structure is used, both elements must be provided.</xs:documentation>
             
</xs:annotation>
             
<xs:element name="LocalPatientIdentifier" type="ns:LocalPatientIdentifier_Type">
               
<xs:annotation>
                 
<xs:documentation>V6-1:
Data element moved into this structure to be controlled by the NHS Number Status Indicator XML Attribute.
</xs:documentation>
               
</xs:annotation>
             
</xs:element>
             
<xs:element name="OrganisationCode_LocalPatientIdentifier" type="ns:OrganisationCode_Type">
               
<xs:annotation>
                 
<xs:documentation>V6-1:
Data element moved into this structure to be controlled by the NHS Number Status Indicator XML Attribute.
</xs:documentation>
               
</xs:annotation>
             
</xs:element>
           
</xs:sequence>
           
<xs:element name="NHSNumber" type="ns:NHSNumber_Type">
             
<xs:annotation>
               
<xs:documentation>XML Mandatory if this data structure is used</xs:documentation>
             
</xs:annotation>
           
</xs:element>
           
<xs:element name="NHSNumberStatusIndicator" type="ns:NHSNumberStatusIndicator_Verified_Type">
             
<xs:annotation>
               
<xs:documentation>XML Mandatory if this data structure is used

Uses "Verified_Type" with a value of 01
</xs:documentation>
             
</xs:annotation>
           
</xs:element>
           
<xs:element name="PatientName" type="ns:PersonName_Structure" minOccurs="0" maxOccurs="0"/>
           
<xs:element name="PatientUsualAddress" type="ns:Address_Structure" minOccurs="0" maxOccurs="0"/>
           
<xs:element name="PostcodeOfUsualAddress" type="ns:PostcodeOfUsualAddress_Type">
             
<xs:annotation>
               
<xs:documentation xml:lang="en">XML Mandatory if this data structure is used
Dispensation has been granted to carry the full POSTCODE data element.
</xs:documentation>
             
</xs:annotation>
           
</xs:element>
           
<xs:element name="OrganisationCode_PCTOfResidence" type="ns:PCT_Code_Type">
             
<xs:annotation>
               
<xs:documentation>XML Mandatory if this data structure is used</xs:documentation>
             
</xs:annotation>
           
</xs:element>
           
<xs:element name="PersonBirthDate" type="ns:PersonBirthDate_Type" minOccurs="0">
             
<xs:annotation>
               
<xs:documentation>V6-1:
Data Element moved into this structure to be controlled by the NHS Number Status Indicator Attribute.
</xs:documentation>
             
</xs:annotation>
           
</xs:element>
         
</xs:sequence>
         
<xs:attribute name="NHSNumberStatusIndicator" type="ns:NHSNumberStatusIndicator_Verified_Type" use="required">
           
<xs:annotation>
             
<xs:documentation>V6-1:
Only Value = 01 is acceptable

Uses "Verified_Type" with a value of 01 for the XML Attribute
</xs:documentation>
           
</xs:annotation>
         
</xs:attribute>
       
</xs:complexType>
     
</xs:element>
     
<xs:element name="UnverifiedIdentity_Structure">
       
<xs:annotation>
         
<xs:documentation>V6-1:
XML Mandatory by choice
AttributeReflects Status
02,03,04,05,06,07,08= all other

Attribute enumerations DO NOT include the values of 91 and 01 as these should always be processed in the preceeding structures.

If the NHS Number Status Indicator contains invalid values, the schema parse will fail. 

Note that code value = 90 is not supported
</xs:documentation>
       
</xs:annotation>
       
<xs:complexType>
         
<xs:sequence>
           
<xs:sequence minOccurs="0">
             
<xs:annotation>
               
<xs:documentation>Where this structure is used, both elements must be provided.</xs:documentation>
             
</xs:annotation>
             
<xs:element name="LocalPatientIdentifier" type="ns:LocalPatientIdentifier_Type">
               
<xs:annotation>
                 
<xs:documentation>V6-1:
Data element moved into this structure to be controlled by the NHS Number Status Indicator XML Attribute.
</xs:documentation>
               
</xs:annotation>
             
</xs:element>
             
<xs:element name="OrganisationCode_LocalPatientIdentifier" type="ns:OrganisationCode_Type">
               
<xs:annotation>
                 
<xs:documentation>V6-1:
Data element moved into this structure to be controlled by the NHS Number Status Indicator XML Attribute.
</xs:documentation>
               
</xs:annotation>
             
</xs:element>
           
</xs:sequence>
           
<xs:element name="NHSNumber" type="ns:NHSNumber_Type" minOccurs="0"/>
           
<xs:element name="NHSNumberStatusIndicator" type="ns:NHSNumberStatusIndicator_Unverified_Type">
             
<xs:annotation>
               
<xs:documentation>XML Mandatory if this data structure is used
V6-1:
Uses "Unverified_Type" with a values of 02,03,04,05,06,07,08
</xs:documentation>
             
</xs:annotation>
           
</xs:element>
           
<xs:element name="PatientName" type="ns:PersonName_Structure" minOccurs="0">
             
<xs:annotation>
               
<xs:documentation>
</xs:documentation>
             
</xs:annotation>
           
</xs:element>
           
<xs:element name="PatientUsualAddress" type="ns:Address_Structure" minOccurs="0"/>
           
<xs:element name="PostcodeOfUsualAddress" type="ns:PostcodeOfUsualAddress_Type" minOccurs="0"/>
           
<xs:element name="OrganisationCode_PCTOfResidence" type="ns:PCT_Code_Type" minOccurs="0"/>
           
<xs:element name="PersonBirthDate" type="ns:PersonBirthDate_Type" minOccurs="0">
             
<xs:annotation>
               
<xs:documentation>V6-1 Data Element moved into this structure to be controlled by the NHS Number Status Indicator Attribute. </xs:documentation>
             
</xs:annotation>
           
</xs:element>
         
</xs:sequence>
         
<xs:attribute name="NHSNumberStatusIndicator" type="ns:NHSNumberStatusIndicator_Unverified_Type" use="required">
           
<xs:annotation>
             
<xs:documentation>V6-1:
Uses the "Unverified_Type" with a values of 02,03,04,05,06,07,08
for the XML Attribute
</xs:documentation>
           
</xs:annotation>
         
</xs:attribute>
       
</xs:complexType>
     
</xs:element>
   
</xs:choice>
 
</xs:sequence>
</xs:complexType>

element PatientIdentity_General_Structure/WithheldIdentity_Structure
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p570.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
properties
isRef 0
content complex
children ns:LocalPatientIdentifier ns:OrganisationCode_LocalPatientIdentifier ns:NHSNumber ns:NHSNumberStatusIndicator ns:PatientName ns:PatientUsualAddress ns:PostcodeOfUsualAddress ns:OrganisationCode_PCTOfResidence ns:PersonBirthDate
attributes
Name  Type  Use  Default  Fixed  annotation
NHSNumberStatusIndicatorns:NHSNumberStatusIndicator_Withheld_Typerequired      
documentation
V6-1:
Only Code Value = 91 is acceptable

Uses the "Withheld_Type" with a value of 91 for the XML Attribute
annotation
documentation
V6-1:
XML Mandatory by choice
Must be first in sequence.
Reflects Status = 91 = Confidential

For patients with sensitive conditions (as defined in DSCN 41/98/P26), all patient identifiable information must be removed from Commissioning Data Set records.
This is indicated when the NHS Number Status Indicator has a code value = 91.

In these cases the
LOCAL PATIENT IDENTIFIER, ORGANISATION CODE (LOCAL PATIENT IDENTIFIER)
NHS NUMBER
PATIENT NAME
PERSON BIRTH DATE
should be omitted from the CDS Types.
source <xs:element name="WithheldIdentity_Structure">
 
<xs:annotation>
   
<xs:documentation>V6-1:
XML Mandatory by choice
Must be first in sequence.
Reflects Status = 91 = Confidential

For patients with sensitive conditions (as defined in DSCN 41/98/P26), all patient identifiable information must be removed from Commissioning Data Set records.
This is indicated when the NHS Number Status Indicator has a code value = 91.

In these cases the
LOCAL PATIENT IDENTIFIER, ORGANISATION CODE (LOCAL PATIENT IDENTIFIER)
NHS NUMBER
PATIENT NAME
PERSON BIRTH DATE
should be omitted from the CDS Types.
</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:sequence minOccurs="0" maxOccurs="0">
       
<xs:annotation>
         
<xs:documentation>Where this structure is used, both elements must be provided.</xs:documentation>
       
</xs:annotation>
       
<xs:element name="LocalPatientIdentifier" type="ns:LocalPatientIdentifier_Type" minOccurs="0" maxOccurs="0">
         
<xs:annotation>
           
<xs:documentation>V6-1:
Data element moved into this structure to be controlled by the NHS Number Status Indicator XML Attribute.
</xs:documentation>
         
</xs:annotation>
       
</xs:element>
       
<xs:element name="OrganisationCode_LocalPatientIdentifier" type="ns:OrganisationCode_Type" minOccurs="0" maxOccurs="0">
         
<xs:annotation>
           
<xs:documentation>V6-1:
Data element moved into this structure to be controlled by the NHS Number Status Indicator XML Attribute.
</xs:documentation>
         
</xs:annotation>
       
</xs:element>
     
</xs:sequence>
     
<xs:element name="NHSNumber" type="ns:NHSNumber_Type" minOccurs="0" maxOccurs="0"/>
     
<xs:element name="NHSNumberStatusIndicator" type="ns:NHSNumberStatusIndicator_Withheld_Type">
       
<xs:annotation>
         
<xs:documentation>V6-1:
XML Mandatory if this data structure is used
Uses "Withheld_Type" with a value of 91
</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="PatientName" type="ns:PersonName_Structure" minOccurs="0" maxOccurs="0"/>
     
<xs:element name="PatientUsualAddress" type="ns:Address_Structure" minOccurs="0" maxOccurs="0"/>
     
<xs:element name="PostcodeOfUsualAddress" type="ns:PostcodeOfUsualAddress_Type" minOccurs="0" maxOccurs="0"/>
     
<xs:element name="OrganisationCode_PCTOfResidence" type="ns:PCT_Code_Type" minOccurs="0"/>
     
<xs:element name="PersonBirthDate" type="ns:PersonBirthDate_Type" minOccurs="0" maxOccurs="0">
       
<xs:annotation>
         
<xs:documentation>V6-1 Data Element moved into this structure to be controlled by the NHS Number Status Indicator Attribute. </xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:sequence>
   
<xs:attribute name="NHSNumberStatusIndicator" type="ns:NHSNumberStatusIndicator_Withheld_Type" use="required">
     
<xs:annotation>
       
<xs:documentation>V6-1:
Only Code Value = 91 is acceptable

Uses the "Withheld_Type" with a value of 91 for the XML Attribute
</xs:documentation>
     
</xs:annotation>
   
</xs:attribute>
 
</xs:complexType>
</xs:element>

attribute PatientIdentity_General_Structure/WithheldIdentity_Structure/@NHSNumberStatusIndicator
type ns:NHSNumberStatusIndicator_Withheld_Type
properties
isRef 0
use required
facets
Kind Value annotation 
totalDigits 
enumeration 90 
annotation
documentation
V6-1:
Only Code Value = 91 is acceptable

Uses the "Withheld_Type" with a value of 91 for the XML Attribute
source <xs:attribute name="NHSNumberStatusIndicator" type="ns:NHSNumberStatusIndicator_Withheld_Type" use="required">
 
<xs:annotation>
   
<xs:documentation>V6-1:
Only Code Value = 91 is acceptable

Uses the "Withheld_Type" with a value of 91 for the XML Attribute
</xs:documentation>
 
</xs:annotation>
</xs:attribute>

element PatientIdentity_General_Structure/WithheldIdentity_Structure/LocalPatientIdentifier
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p571.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
type ns:LocalPatientIdentifier_Type
properties
isRef 0
minOcc 0
maxOcc 0
content simple
facets
Kind Value annotation 
maxLength 10 
annotation
documentation
V6-1:
Data element moved into this structure to be controlled by the NHS Number Status Indicator XML Attribute.
source <xs:element name="LocalPatientIdentifier" type="ns:LocalPatientIdentifier_Type" minOccurs="0" maxOccurs="0">
 
<xs:annotation>
   
<xs:documentation>V6-1:
Data element moved into this structure to be controlled by the NHS Number Status Indicator XML Attribute.
</xs:documentation>
 
</xs:annotation>
</xs:element>

element PatientIdentity_General_Structure/WithheldIdentity_Structure/OrganisationCode_LocalPatientIdentifier
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p572.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
type ns:OrganisationCode_Type
properties
isRef 0
minOcc 0
maxOcc 0
content simple
facets
Kind Value annotation 
minLength 
maxLength 
annotation
documentation
V6-1:
Data element moved into this structure to be controlled by the NHS Number Status Indicator XML Attribute.
source <xs:element name="OrganisationCode_LocalPatientIdentifier" type="ns:OrganisationCode_Type" minOccurs="0" maxOccurs="0">
 
<xs:annotation>
   
<xs:documentation>V6-1:
Data element moved into this structure to be controlled by the NHS Number Status Indicator XML Attribute.
</xs:documentation>
 
</xs:annotation>
</xs:element>

element PatientIdentity_General_Structure/WithheldIdentity_Structure/NHSNumber
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p573.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
type ns:NHSNumber_Type
properties
isRef 0
minOcc 0
maxOcc 0
content simple
facets
Kind Value annotation 
pattern [0-9]{10} 
source <xs:element name="NHSNumber" type="ns:NHSNumber_Type" minOccurs="0" maxOccurs="0"/>

element PatientIdentity_General_Structure/WithheldIdentity_Structure/NHSNumberStatusIndicator
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p574.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
type ns:NHSNumberStatusIndicator_Withheld_Type
properties
isRef 0
content simple
facets
Kind Value annotation 
totalDigits 
enumeration 90 
annotation
documentation
V6-1:
XML Mandatory if this data structure is used
Uses "Withheld_Type" with a value of 91
source <xs:element name="NHSNumberStatusIndicator" type="ns:NHSNumberStatusIndicator_Withheld_Type">
 
<xs:annotation>
   
<xs:documentation>V6-1:
XML Mandatory if this data structure is used
Uses "Withheld_Type" with a value of 91
</xs:documentation>
 
</xs:annotation>
</xs:element>

element PatientIdentity_General_Structure/WithheldIdentity_Structure/PatientName
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p575.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
type ns:PersonName_Structure
properties
isRef 0
minOcc 0
maxOcc 0
content complex
children ns:PersonFullName ns:PersonName_Structured ns:PersonRequestedName
source <xs:element name="PatientName" type="ns:PersonName_Structure" minOccurs="0" maxOccurs="0"/>

element PatientIdentity_General_Structure/WithheldIdentity_Structure/PatientUsualAddress
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p576.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
type ns:Address_Structure
properties
isRef 0
minOcc 0
maxOcc 0
content complex
children ns:UnstructuredAddress ns:StructuredAddress
source <xs:element name="PatientUsualAddress" type="ns:Address_Structure" minOccurs="0" maxOccurs="0"/>

element PatientIdentity_General_Structure/WithheldIdentity_Structure/PostcodeOfUsualAddress
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p577.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
type ns:PostcodeOfUsualAddress_Type
properties
isRef 0
minOcc 0
maxOcc 0
content simple
facets
Kind Value annotation 
maxLength 
source <xs:element name="PostcodeOfUsualAddress" type="ns:PostcodeOfUsualAddress_Type" minOccurs="0" maxOccurs="0"/>

element PatientIdentity_General_Structure/WithheldIdentity_Structure/OrganisationCode_PCTOfResidence
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p578.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
type ns:PCT_Code_Type
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
length 
source <xs:element name="OrganisationCode_PCTOfResidence" type="ns:PCT_Code_Type" minOccurs="0"/>

element PatientIdentity_General_Structure/WithheldIdentity_Structure/PersonBirthDate
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p579.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
type ns:PersonBirthDate_Type
properties
isRef 0
minOcc 0
maxOcc 0
content simple
annotation
documentation
V6-1 Data Element moved into this structure to be controlled by the NHS Number Status Indicator Attribute.
source <xs:element name="PersonBirthDate" type="ns:PersonBirthDate_Type" minOccurs="0" maxOccurs="0">
 
<xs:annotation>
   
<xs:documentation>V6-1 Data Element moved into this structure to be controlled by the NHS Number Status Indicator Attribute. </xs:documentation>
 
</xs:annotation>
</xs:element>

element PatientIdentity_General_Structure/VerifiedIdentity_Structure
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p580.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
properties
isRef 0
content complex
children ns:LocalPatientIdentifier ns:OrganisationCode_LocalPatientIdentifier ns:NHSNumber ns:NHSNumberStatusIndicator ns:PatientName ns:PatientUsualAddress ns:PostcodeOfUsualAddress ns:OrganisationCode_PCTOfResidence ns:PersonBirthDate
attributes
Name  Type  Use  Default  Fixed  annotation
NHSNumberStatusIndicatorns:NHSNumberStatusIndicator_Verified_Typerequired      
documentation
V6-1:
Only Value = 01 is acceptable

Uses "Verified_Type" with a value of 01 for the XML Attribute
annotation
documentation
V6-1:
XML Mandatory by choice.
AttributeReflects Status= 01= Verified.

If the NHS Number has been Verified - it must also be Valid with the correct format and Modulus 11 Check Digit.  The schema does not check "validity".

For reasons of confidentiality, the patient's NAMEand ADDRESS (not including POSTCODE OF USUAL ADDRESS) must NOT be carried where a valid NHS Number is present.

source <xs:element name="VerifiedIdentity_Structure">
 
<xs:annotation>
   
<xs:documentation>V6-1:
XML Mandatory by choice.
AttributeReflects Status= 01= Verified.

If the NHS Number has been Verified - it must also be Valid with the correct format and Modulus 11 Check Digit.  The schema does not check "validity".

For reasons of confidentiality, the patient's NAMEand ADDRESS (not including POSTCODE OF USUAL ADDRESS) must NOT be carried where a valid NHS Number is present.

</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:sequence minOccurs="0">
       
<xs:annotation>
         
<xs:documentation>Where this structure is used, both elements must be provided.</xs:documentation>
       
</xs:annotation>
       
<xs:element name="LocalPatientIdentifier" type="ns:LocalPatientIdentifier_Type">
         
<xs:annotation>
           
<xs:documentation>V6-1:
Data element moved into this structure to be controlled by the NHS Number Status Indicator XML Attribute.
</xs:documentation>
         
</xs:annotation>
       
</xs:element>
       
<xs:element name="OrganisationCode_LocalPatientIdentifier" type="ns:OrganisationCode_Type">
         
<xs:annotation>
           
<xs:documentation>V6-1:
Data element moved into this structure to be controlled by the NHS Number Status Indicator XML Attribute.
</xs:documentation>
         
</xs:annotation>
       
</xs:element>
     
</xs:sequence>
     
<xs:element name="NHSNumber" type="ns:NHSNumber_Type">
       
<xs:annotation>
         
<xs:documentation>XML Mandatory if this data structure is used</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="NHSNumberStatusIndicator" type="ns:NHSNumberStatusIndicator_Verified_Type">
       
<xs:annotation>
         
<xs:documentation>XML Mandatory if this data structure is used

Uses "Verified_Type" with a value of 01
</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="PatientName" type="ns:PersonName_Structure" minOccurs="0" maxOccurs="0"/>
     
<xs:element name="PatientUsualAddress" type="ns:Address_Structure" minOccurs="0" maxOccurs="0"/>
     
<xs:element name="PostcodeOfUsualAddress" type="ns:PostcodeOfUsualAddress_Type">
       
<xs:annotation>
         
<xs:documentation xml:lang="en">XML Mandatory if this data structure is used
Dispensation has been granted to carry the full POSTCODE data element.
</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="OrganisationCode_PCTOfResidence" type="ns:PCT_Code_Type">
       
<xs:annotation>
         
<xs:documentation>XML Mandatory if this data structure is used</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="PersonBirthDate" type="ns:PersonBirthDate_Type" minOccurs="0">
       
<xs:annotation>
         
<xs:documentation>V6-1:
Data Element moved into this structure to be controlled by the NHS Number Status Indicator Attribute.
</xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:sequence>
   
<xs:attribute name="NHSNumberStatusIndicator" type="ns:NHSNumberStatusIndicator_Verified_Type" use="required">
     
<xs:annotation>
       
<xs:documentation>V6-1:
Only Value = 01 is acceptable

Uses "Verified_Type" with a value of 01 for the XML Attribute
</xs:documentation>
     
</xs:annotation>
   
</xs:attribute>
 
</xs:complexType>
</xs:element>

attribute PatientIdentity_General_Structure/VerifiedIdentity_Structure/@NHSNumberStatusIndicator
type ns:NHSNumberStatusIndicator_Verified_Type
properties
isRef 0
use required
facets
Kind Value annotation 
totalDigits 
enumeration 01 
annotation
documentation
V6-1:
Only Value = 01 is acceptable

Uses "Verified_Type" with a value of 01 for the XML Attribute
source <xs:attribute name="NHSNumberStatusIndicator" type="ns:NHSNumberStatusIndicator_Verified_Type" use="required">
 
<xs:annotation>
   
<xs:documentation>V6-1:
Only Value = 01 is acceptable

Uses "Verified_Type" with a value of 01 for the XML Attribute
</xs:documentation>
 
</xs:annotation>
</xs:attribute>

element PatientIdentity_General_Structure/VerifiedIdentity_Structure/LocalPatientIdentifier
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p581.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
type ns:LocalPatientIdentifier_Type
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 10 
annotation
documentation
V6-1:
Data element moved into this structure to be controlled by the NHS Number Status Indicator XML Attribute.
source <xs:element name="LocalPatientIdentifier" type="ns:LocalPatientIdentifier_Type">
 
<xs:annotation>
   
<xs:documentation>V6-1:
Data element moved into this structure to be controlled by the NHS Number Status Indicator XML Attribute.
</xs:documentation>
 
</xs:annotation>
</xs:element>

element PatientIdentity_General_Structure/VerifiedIdentity_Structure/OrganisationCode_LocalPatientIdentifier
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p582.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
type ns:OrganisationCode_Type
properties
isRef 0
content simple
facets
Kind Value annotation 
minLength 
maxLength 
annotation
documentation
V6-1:
Data element moved into this structure to be controlled by the NHS Number Status Indicator XML Attribute.
source <xs:element name="OrganisationCode_LocalPatientIdentifier" type="ns:OrganisationCode_Type">
 
<xs:annotation>
   
<xs:documentation>V6-1:
Data element moved into this structure to be controlled by the NHS Number Status Indicator XML Attribute.
</xs:documentation>
 
</xs:annotation>
</xs:element>

element PatientIdentity_General_Structure/VerifiedIdentity_Structure/NHSNumber
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p583.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
type ns:NHSNumber_Type
properties
isRef 0
content simple
facets
Kind Value annotation 
pattern [0-9]{10} 
annotation
documentation
XML Mandatory if this data structure is used
source <xs:element name="NHSNumber" type="ns:NHSNumber_Type">
 
<xs:annotation>
   
<xs:documentation>XML Mandatory if this data structure is used</xs:documentation>
 
</xs:annotation>
</xs:element>

element PatientIdentity_General_Structure/VerifiedIdentity_Structure/NHSNumberStatusIndicator
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p584.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
type ns:NHSNumberStatusIndicator_Verified_Type
properties
isRef 0
content simple
facets
Kind Value annotation 
totalDigits 
enumeration 01 
annotation
documentation
XML Mandatory if this data structure is used

Uses "Verified_Type" with a value of 01
source <xs:element name="NHSNumberStatusIndicator" type="ns:NHSNumberStatusIndicator_Verified_Type">
 
<xs:annotation>
   
<xs:documentation>XML Mandatory if this data structure is used

Uses "Verified_Type" with a value of 01
</xs:documentation>
 
</xs:annotation>
</xs:element>

element PatientIdentity_General_Structure/VerifiedIdentity_Structure/PatientName
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p585.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
type ns:PersonName_Structure
properties
isRef 0
minOcc 0
maxOcc 0
content complex
children ns:PersonFullName ns:PersonName_Structured ns:PersonRequestedName
source <xs:element name="PatientName" type="ns:PersonName_Structure" minOccurs="0" maxOccurs="0"/>

element PatientIdentity_General_Structure/VerifiedIdentity_Structure/PatientUsualAddress
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p586.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
type ns:Address_Structure
properties
isRef 0
minOcc 0
maxOcc 0
content complex
children ns:UnstructuredAddress ns:StructuredAddress
source <xs:element name="PatientUsualAddress" type="ns:Address_Structure" minOccurs="0" maxOccurs="0"/>

element PatientIdentity_General_Structure/VerifiedIdentity_Structure/PostcodeOfUsualAddress
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p587.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
type ns:PostcodeOfUsualAddress_Type
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 
annotation
documentation
XML Mandatory if this data structure is used
Dispensation has been granted to carry the full POSTCODE data element.
source <xs:element name="PostcodeOfUsualAddress" type="ns:PostcodeOfUsualAddress_Type">
 
<xs:annotation>
   
<xs:documentation xml:lang="en">XML Mandatory if this data structure is used
Dispensation has been granted to carry the full POSTCODE data element.
</xs:documentation>
 
</xs:annotation>
</xs:element>

element PatientIdentity_General_Structure/VerifiedIdentity_Structure/OrganisationCode_PCTOfResidence
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p588.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
type ns:PCT_Code_Type
properties
isRef 0
content simple
facets
Kind Value annotation 
length 
annotation
documentation
XML Mandatory if this data structure is used
source <xs:element name="OrganisationCode_PCTOfResidence" type="ns:PCT_Code_Type">
 
<xs:annotation>
   
<xs:documentation>XML Mandatory if this data structure is used</xs:documentation>
 
</xs:annotation>
</xs:element>

element PatientIdentity_General_Structure/VerifiedIdentity_Structure/PersonBirthDate
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p589.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
type ns:PersonBirthDate_Type
properties
isRef 0
minOcc 0
maxOcc 1
content simple
annotation
documentation
V6-1:
Data Element moved into this structure to be controlled by the NHS Number Status Indicator Attribute.
source <xs:element name="PersonBirthDate" type="ns:PersonBirthDate_Type" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>V6-1:
Data Element moved into this structure to be controlled by the NHS Number Status Indicator Attribute.
</xs:documentation>
 
</xs:annotation>
</xs:element>

element PatientIdentity_General_Structure/UnverifiedIdentity_Structure
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p590.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
properties
isRef 0
content complex
children ns:LocalPatientIdentifier ns:OrganisationCode_LocalPatientIdentifier ns:NHSNumber ns:NHSNumberStatusIndicator ns:PatientName ns:PatientUsualAddress ns:PostcodeOfUsualAddress ns:OrganisationCode_PCTOfResidence ns:PersonBirthDate
attributes
Name  Type  Use  Default  Fixed  annotation
NHSNumberStatusIndicatorns:NHSNumberStatusIndicator_Unverified_Typerequired      
documentation
V6-1:
Uses the "Unverified_Type" with a values of 02,03,04,05,06,07,08
for the XML Attribute
annotation
documentation
V6-1:
XML Mandatory by choice
AttributeReflects Status
02,03,04,05,06,07,08= all other

Attribute enumerations DO NOT include the values of 91 and 01 as these should always be processed in the preceeding structures.

If the NHS Number Status Indicator contains invalid values, the schema parse will fail. 

Note that code value = 90 is not supported
source <xs:element name="UnverifiedIdentity_Structure">
 
<xs:annotation>
   
<xs:documentation>V6-1:
XML Mandatory by choice
AttributeReflects Status
02,03,04,05,06,07,08= all other

Attribute enumerations DO NOT include the values of 91 and 01 as these should always be processed in the preceeding structures.

If the NHS Number Status Indicator contains invalid values, the schema parse will fail. 

Note that code value = 90 is not supported
</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:sequence minOccurs="0">
       
<xs:annotation>
         
<xs:documentation>Where this structure is used, both elements must be provided.</xs:documentation>
       
</xs:annotation>
       
<xs:element name="LocalPatientIdentifier" type="ns:LocalPatientIdentifier_Type">
         
<xs:annotation>
           
<xs:documentation>V6-1:
Data element moved into this structure to be controlled by the NHS Number Status Indicator XML Attribute.
</xs:documentation>
         
</xs:annotation>
       
</xs:element>
       
<xs:element name="OrganisationCode_LocalPatientIdentifier" type="ns:OrganisationCode_Type">
         
<xs:annotation>
           
<xs:documentation>V6-1:
Data element moved into this structure to be controlled by the NHS Number Status Indicator XML Attribute.
</xs:documentation>
         
</xs:annotation>
       
</xs:element>
     
</xs:sequence>
     
<xs:element name="NHSNumber" type="ns:NHSNumber_Type" minOccurs="0"/>
     
<xs:element name="NHSNumberStatusIndicator" type="ns:NHSNumberStatusIndicator_Unverified_Type">
       
<xs:annotation>
         
<xs:documentation>XML Mandatory if this data structure is used
V6-1:
Uses "Unverified_Type" with a values of 02,03,04,05,06,07,08
</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="PatientName" type="ns:PersonName_Structure" minOccurs="0">
       
<xs:annotation>
         
<xs:documentation>
</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="PatientUsualAddress" type="ns:Address_Structure" minOccurs="0"/>
     
<xs:element name="PostcodeOfUsualAddress" type="ns:PostcodeOfUsualAddress_Type" minOccurs="0"/>
     
<xs:element name="OrganisationCode_PCTOfResidence" type="ns:PCT_Code_Type" minOccurs="0"/>
     
<xs:element name="PersonBirthDate" type="ns:PersonBirthDate_Type" minOccurs="0">
       
<xs:annotation>
         
<xs:documentation>V6-1 Data Element moved into this structure to be controlled by the NHS Number Status Indicator Attribute. </xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:sequence>
   
<xs:attribute name="NHSNumberStatusIndicator" type="ns:NHSNumberStatusIndicator_Unverified_Type" use="required">
     
<xs:annotation>
       
<xs:documentation>V6-1:
Uses the "Unverified_Type" with a values of 02,03,04,05,06,07,08
for the XML Attribute
</xs:documentation>
     
</xs:annotation>
   
</xs:attribute>
 
</xs:complexType>
</xs:element>

attribute PatientIdentity_General_Structure/UnverifiedIdentity_Structure/@NHSNumberStatusIndicator
type ns:NHSNumberStatusIndicator_Unverified_Type
properties
isRef 0
use required
facets
Kind Value annotation 
totalDigits 
enumeration 02 
enumeration 03 
enumeration 04 
enumeration 05 
enumeration 06 
enumeration 07 
enumeration 08 
annotation
documentation
V6-1:
Uses the "Unverified_Type" with a values of 02,03,04,05,06,07,08
for the XML Attribute
source <xs:attribute name="NHSNumberStatusIndicator" type="ns:NHSNumberStatusIndicator_Unverified_Type" use="required">
 
<xs:annotation>
   
<xs:documentation>V6-1:
Uses the "Unverified_Type" with a values of 02,03,04,05,06,07,08
for the XML Attribute
</xs:documentation>
 
</xs:annotation>
</xs:attribute>

element PatientIdentity_General_Structure/UnverifiedIdentity_Structure/LocalPatientIdentifier
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p591.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
type ns:LocalPatientIdentifier_Type
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 10 
annotation
documentation
V6-1:
Data element moved into this structure to be controlled by the NHS Number Status Indicator XML Attribute.
source <xs:element name="LocalPatientIdentifier" type="ns:LocalPatientIdentifier_Type">
 
<xs:annotation>
   
<xs:documentation>V6-1:
Data element moved into this structure to be controlled by the NHS Number Status Indicator XML Attribute.
</xs:documentation>
 
</xs:annotation>
</xs:element>

element PatientIdentity_General_Structure/UnverifiedIdentity_Structure/OrganisationCode_LocalPatientIdentifier
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p592.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
type ns:OrganisationCode_Type
properties
isRef 0
content simple
facets
Kind Value annotation 
minLength 
maxLength 
annotation
documentation
V6-1:
Data element moved into this structure to be controlled by the NHS Number Status Indicator XML Attribute.
source <xs:element name="OrganisationCode_LocalPatientIdentifier" type="ns:OrganisationCode_Type">
 
<xs:annotation>
   
<xs:documentation>V6-1:
Data element moved into this structure to be controlled by the NHS Number Status Indicator XML Attribute.
</xs:documentation>
 
</xs:annotation>
</xs:element>

element PatientIdentity_General_Structure/UnverifiedIdentity_Structure/NHSNumber
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p593.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
type ns:NHSNumber_Type
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
pattern [0-9]{10} 
source <xs:element name="NHSNumber" type="ns:NHSNumber_Type" minOccurs="0"/>

element PatientIdentity_General_Structure/UnverifiedIdentity_Structure/NHSNumberStatusIndicator
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p594.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
type ns:NHSNumberStatusIndicator_Unverified_Type
properties
isRef 0
content simple
facets
Kind Value annotation 
totalDigits 
enumeration 02 
enumeration 03 
enumeration 04 
enumeration 05 
enumeration 06 
enumeration 07 
enumeration 08 
annotation
documentation
XML Mandatory if this data structure is used
V6-1:
Uses "Unverified_Type" with a values of 02,03,04,05,06,07,08
source <xs:element name="NHSNumberStatusIndicator" type="ns:NHSNumberStatusIndicator_Unverified_Type">
 
<xs:annotation>
   
<xs:documentation>XML Mandatory if this data structure is used
V6-1:
Uses "Unverified_Type" with a values of 02,03,04,05,06,07,08
</xs:documentation>
 
</xs:annotation>
</xs:element>

element PatientIdentity_General_Structure/UnverifiedIdentity_Structure/PatientName
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p595.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
type ns:PersonName_Structure
properties
isRef 0
minOcc 0
maxOcc 1
content complex
children ns:PersonFullName ns:PersonName_Structured ns:PersonRequestedName
annotation
documentation

source <xs:element name="PatientName" type="ns:PersonName_Structure" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>
</xs:documentation>
 
</xs:annotation>
</xs:element>

element PatientIdentity_General_Structure/UnverifiedIdentity_Structure/PatientUsualAddress
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p596.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
type ns:Address_Structure
properties
isRef 0
minOcc 0
maxOcc 1
content complex
children ns:UnstructuredAddress ns:StructuredAddress
source <xs:element name="PatientUsualAddress" type="ns:Address_Structure" minOccurs="0"/>

element PatientIdentity_General_Structure/UnverifiedIdentity_Structure/PostcodeOfUsualAddress
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p597.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
type ns:PostcodeOfUsualAddress_Type
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
maxLength 
source <xs:element name="PostcodeOfUsualAddress" type="ns:PostcodeOfUsualAddress_Type" minOccurs="0"/>

element PatientIdentity_General_Structure/UnverifiedIdentity_Structure/OrganisationCode_PCTOfResidence
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p598.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
type ns:PCT_Code_Type
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
length 
source <xs:element name="OrganisationCode_PCTOfResidence" type="ns:PCT_Code_Type" minOccurs="0"/>

element PatientIdentity_General_Structure/UnverifiedIdentity_Structure/PersonBirthDate
diagram CDS-XML_Schema_Documentation-v6-1-1-2010-12-10_p599.png
namespace http://www.nhsia.nhs.uk/DataStandards/XMLschema/CDS/ns
type ns:PersonBirthDate_Type
properties
isRef 0
minOcc 0
maxOcc 1
content simple
annotation
documentation
V6-1 Data Element moved into this structure to be controlled by the NHS Number Status Indicator Attribute.
source <xs:element name="PersonBirthDate" type="ns:PersonBirthDate_Type" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>V6-1 Data Element moved into this structure to be controlled by the NHS Number Status Indicator Attribute. </xs:documentation>
 
</xs:annotation>
</xs:element>


XML Schema documentation generated by
XMLSpy Schema Editor http://www.altova.com/xmlspy