PdsCreateInitialRecordRequest - tabular view

Requests that a record be created on a patient administration system.

A code indicating that the act is of registration

• Fixed value: "REG"

A code indicating that the act is an event.

• Fixed value: "EVN"

The RegisteringAuthority serves as the Author of this message.

A code indicating that the target participates as an Author

• Fixed value: "AUT"

A link to details of the authority for the registration.

Information about whether the PDS is to ignore the presence of records which are a potential duplicate of the submitted record.

A code indicating that the linked Act contains pertinent information.

• Fixed value: "PERT"

A link to details of whether to ignore duplicate records when attempting to register the record on the PDS.

The patient who is the subject of the request to create a record.

Indicates that the target Role is the subject of the Act

• Fixed Value : "SBJ"

A link to details of a patient.

Parent class linking to and containing details of the authority for the registration.

Indicates that the role is that of an entity acting in the employ of an Organization

• Fixed value: "ASSIGNED" (Assigned entity)

Value from the RegisteringAuthorityTypevocabulary.

The Coded with Code System datatype flavour is used to carry this information as follows:

• The code attribute will contain the appropriate value from the RegisteringAuthorityType vocabulary
• The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.16.20"

The identifier of the assigned organisation acting as registration authority. This will be :

• Organisation code (PCT code or Trust code)

The Identifier External datatype flavour is used to carry this information as follows:

• The root attribute will contain an OID with the value "2.16.840.1.113883.2.1.4.3"
• The extension attribute will contain the national organisation code

Indicates whether the PDS registration server should ignore the possibility that this is a duplicate record.

If this criterion is present, the registration shall proceed regardless of the presence of a possible duplicate.

A code indicating that the act is an observation

• Fixed value: "OBS"

Indicates this is a criterion.

• Fixed value: "EVN.CRT" (Event)

If true, indicates that duplicate patients should be ignored when creating the PDS Record.

The role of the Patient who a record is being created for.

A code indicating that the role is that of a Patient

• Fixed value: "PAT"

Address(es) of the patient.

The particular flavour of the address datatype used here is Address streetAddressLine Typed (format 2 in the datatypes description), plus:

• Optional Postcode
• Optional Address Key
• Optional Description
• Mandatory Use

This means that the address will contain the following components:

• Between one and five streetAddressLine elements. Excludes postcode, may be vernacular or PAF-derived. For vernacular addresses, the following formatting convention should be used:
  • Line 1: premises ID
  • Line 2: no. / thoroughfare
  • Line 3: locality
  • Line 4: post town
  • Line 5: county
  • Lines 1 or 2 and line 4 are mandatory
• A postalCode element to carry a postcode (optional)
• An addressKey element to carry a PAF key (optional)
• A desc element to carry a free-text description of the nature of the address (e.g. "On holiday") (optional, may only be present for a temporary address, i.e. if the use attribute is "TMP")
• The use attribute to denote the type of address. Only the values "H" (Home address) and "TMP" (Temporary address) are permitted here. (mandatory)

One instance of home address (use type "H") is mandatory and one instance of a discharge address (i.e. temporary - use type "TMP") is optional, where different from usual address.

NB The business effective date for all data being added to the PDS that has an associated business effective date must always be provided. In this case, the useablePeriod element should be used wherever possible.

Specifies a means of communicating remotely with the Person

The valid flavours of the TEL datatype are

2. Telecommunication address plus use (f)

4. Telecommunication address plus use and valid time. (f)

NB The business effective date for all data being added to the PDS that has an associated business effective date must always be provided. In this case, the useablePeriod element should be used wherever possible.

The person playing the role of patient.

The participation of the Patient in their own birth.

A code indicating that the participant is a baby

• Fixed value: "BBY"

A link to details of an obstetric care provision event.

The birthweight of the patient

Indicates that the target Role is the subject of the Act

• Fixed Value : "SBJ"

A link to details of the patient's birth weight.

Clinical information relevant to the patient.

Indicates that the target Role is the subject of the Act

• Fixed Value : "SBJ"

A link to details of clinical information about the patient.

Indicates whether the patient is deceased or not.

NB This can occur independantly of stillbirth

Indicates that the target Role is the subject of the Act

• Fixed Value : "SBJ"

A link to details of the patient's death notification status.

The Person entity playing the role of Patient in this message.

A code indicating that the entity is a Person

• Fixed value: "PSN"

Indicates that this is an actual instance of the entity, and not a general description of a class of entity

• Fixed value: "INSTANCE"

The sex of the person (e.g., female, male).

• This code is for administrative purposes only and does not imply a particular genetic or physical sex. Therefore, were gender is indeterminate the value should be as registered with the health provider.

The full date and time of birth of the Person being registered.

If the patient is deceased then this attribute shall carry the date and time of their death.

If the patient is not deceased then this attribute shall be absent.

The ethnic category of the patient represented in coded form.

The Coded with Code System datatype flavour is used to carry this information as follows:

• The codeattribute shall contain a value from the list of codes in the EthnicCategoryvocabulary.
• The codeSystemattribute will contain the OID referenced in the EthnicCategoryvocabulary

For a birth registration this is mandatory and describes the sequence in the case of multiple births (e.g. twins, triplets etc).

For births that are not a part of a multiple birth, this will be set to 1.

Note that permissible values are 1-9, with any value between

• 1 and 7 inclusive indicating the actual birth order number,
• 8 meaning "Not applicable" and
• 9 meaning "Not known".

The name of the Person.

The appropriate flavours of the PN datatype to use are

6. Person name structured with use (f)

8. Person name structured with use and valid time (f)

The name shall contain zero or one <family/> element and between zero and two <given/> elements.

The prefix and suffix components are also supported.

The only value of "use" relevant is "L" - Usual (current) name

NB - while more than two <given/> name elements may be present in the PN datatype, the PDS requires given names subsequent to the first to be concatenated into the second given name field of its API.

NB - The business effective date for all data being added to the PDS that has an associated business effective date must always be provided. In this case, the flavour with valid time should be used wherever possible.

A heading for providing information about a death notification.

Indicates that this is an observation.

• Fixed value: "OBS" (Observation)

Indicates this is an event.

• Fixed value: "EVN" (Event)

To provide the type of observation in coded form.

In this context, the type of observation is an observation of a death notification.

The Coded with Code System datatype flavour is used to carry this information as follows:

• The code attribute will contain value "3" (Death notification) from the list of codes in the DemographicObservationType vocabulary;
• The codeSystem attribute will contain the OID referenced in the DemographicObservationType vocabulary.

To provide the registration status of the death notification in coded form.

The Coded with Code System datatype flavour is used to carry this information as follows:

• The code attribute will contain a value from the list of codes in the DeathNotification vocabulary;
• The codeSystem attribute will contain the OID referenced in the DeathNotification vocabulary.

An observation of the weight of the patient at birth

A code indicating that the act is an observation

• Fixed value: "OBS"

Indicates this is an event.

• Fixed value: "EVN" (Event)

A code from the SnomedCT vocabulary. The Coded with Code System datatype flavour is used to carry this information as follows:

• The code attribute will contain the appropriate value from the SnomedCT vocabulary
  • Fixed value = 364589006 "birth weight"
• The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.15"

The weight of the baby at birth. 4-digits, fixed length. 0000..9999 grams. 9999 meaning unweighed (according to NHS Data Dictionary). If 0000 is supplied, it will be treated as 9999.

A composition of relevant clinical information appropriate to registration.

A code indicating that the act is an grouping of other acts

• Fixed value: "COMPOSITION"

Indicates this is an event.

• Fixed value: "EVN" (Event)

Indicates whether there is a suspected congenital abnormality or the baby is normal.

A code indicating that the linked act is a component

• Fixed value: "COMP"

A link to details of whether there is a suspected congenital abnormality.

Indicates whether the baby was stillborn.

A code indicating that the linked act is a component

• Fixed value: "COMP"

A link to details of whether the baby was stillborn.

The number of foetuses in confinement.

A code indicating that the linked act is a component

• Fixed value: "COMP"

A link to details of the number of foetuses in confinement.

Indicates the gestational age of the baby at birth.

A code indicating that the linked act is a component

• Fixed value: "COMP"

A link to details of the baby's gestational age.

Observation of the number of foetuses in confinement in the pregnancy containing the Patient.

A code indicating that the act is an observation

• Fixed value: "OBS"

Indicates this is an event.

• Fixed value: "EVN" (Event)

A code from the SnomedCT vocabulary. The Coded with Code System datatype flavour is used to carry this information as follows:

• The code attribute will contain the appropriate value from the SnomedCT vocabulary
  • Fixed value = 246435002 "number of fetuses"
• The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.15"

The gestational age of the Person at birth.

A code indicating that the act is an observation

• Fixed value: "OBS"

Indicates this is an event.

• Fixed value: "EVN" (Event)

A code from the SnomedCT vocabulary. The Coded with Code System datatype flavour is used to carry this information as follows:

• The code attribute will contain the appropriate value from the SnomedCT vocabulary
  • Fixed value = 268477000 "fetal gestation at delivery"
• The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.15"

Details of the gestational age of the baby. This will be a 2 digit (fixed length) number in the range 10-49 representing a number of weeks. 00 and 99 are also supported meaning "unknown".

An indicator as to whether the Person was stillborn.

NB. This is distinct data from whether the person is deceased as the latter may occur after birth but before registration of the Patient.

A code indicating that the act is an observation

• Fixed value: "OBS"

Indicates this is an event.

• Fixed value: "EVN" (Event)

A code from the SnomedCT vocabulary. The Coded with Code System datatype flavour is used to carry this information as follows:

• The code attribute will contain the appropriate value from the SnomedCT vocabulary
  • Fixed value = 237364002 "stillbirth"
• The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.15"

Observation detailing whether the Patient has a suspected congenital abnormality (or the absence of one) at birth.

A code indicating that the act is an observation

• Fixed value: "OBS"

Indicates this is an event.

• Fixed value: "EVN" (Event)

A code from the SnomedCT vocabulary. The Coded Qualified datatype flavour is used to carry this information as follows:

• The code attribute will contain the appropriate value from the SnomedCT vocabulary
  • Fixed value = 66091009 "congenital disease"
    • Fixed qualifier = 415684004 "suspected"
• The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.15"

Coded value as detailed in the SuspectedCongenitalAbnormalityType vocabulary.

The Coded with Code System datatype flavour is used to carry this information as follows:

• The code attribute will contain the appropriate value from the SuspectedCongenitalAbnormalityType vocabulary
• The codeSystem attribute will contain the OID referenced in the SuspectedCongenitalAbnormalityType vocabulary

The act of provision of obstetric care to the mother of the patient being registered.

Signifies that this is an act of patient care provision.

• Fixed value "PCPR"

Indicates this is an event.

• Fixed value: "EVN" (Event)

A code from the ActMedicalServiceCode vocabulary. The Coded Simple Value datatype flavour is used to carry this information as follows:

• The code attribute will contain the appropriate value from the ActMedicalServiceCode vocabulary
  • Fixed Value : "OBS"

The participation of the author of the notification.

A code indicating that the target participates as an Author

• Fixed value: "AUT"

A link to details of the notifying person for the birth.

The location of the birth.

Indicates that the role is participating as a Location.

A link to details of the delivery location.

Participation of the Partner Child Health organization.

Recipient to who an act statement is primaryily directed.

• Fixed Value : "PRCP" (Primary information recipient)

A link to details of the partner child health organisation.

The participation of the Mother in the formation of her obstetric record.

A code indicating that the target participates as a Record Target

• Fixed value: "RCT"

A link to details of the mother.

Participation of the Responsible Child Health organization.

A secondary information recipient who receives copies.

• Fixed Value : "TRC" (Tracker)

A link to details of the responsible child health organisation.

Choice of expression of DeliveryLocation

Choice is per the DeliveryPlaceType of the birth location.

• Where the coded value is in the set [0,2,3,4,5,6,7], IdentifiedDeliveryLocation shall be used.
• Where the coded value is not in this set, DeliveryLocation shall be used.

This role shall be used when the @code attribute is in the set [0,2,3,4,5,6,7]

This role shall be used when the @code attribute is in the set [1,8,9]

The role of a delivery location which carries a national identifier.

Indicates that the role that of a Located Entity

• Fixed Value : "LOCE"

A value from the DeliveryLocationType vocabulary indicating the type of location.

• Restricted to values [0,2,3,4,5,6,7]

The Coded with Code System datatype flavour is used to carry this information as follows:

• The code attribute will contain the appropriate value from the DeliveryLocationType vocabulary
• The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.17.173"

The identifier of the organisation acting as service delivery location.

The Identifier External datatype flavour is used to carry this information as follows:

• The root attribute will contain an OID with the value "1.2.826.0.1285.0.1.10"
• The extension attribute will contain the SDS Organisation ID

The place of birth

The place of birth for the registered patient.

Indicates a physical place.

Indicates that this is an actual instance of the entity, and not a general description of a class of entity

• Fixed value: "INSTANCE"

Details of the patients place of birth in as much detail as is available, i.e., may just be the country the patient was born in, but could also be the county and/or the town. The permissible elements are listed below, at least one which must be populated.

The AD.NPfIT.CodedCountry datatype flavour will be used to express this attribute.

• country
  • The country element contains a code element
    • The codeSystem attribute will contain a valid OID for the CountryOrUkInternalCode vocabulary
    • The code attribute will contain the relevant code
    • Permissible values are limited to the set of England, Wales and the Isle of Man
• county
• city

The name of the hospital or maternity unit where the birth took place.

This attribute is mandatory, except where the DeliveryLocationType of the location is 1,8 or 9.

The role of a delivery location which is not specifically identified.

Indicates that the role that of a Located Entity

• Fixed Value : "LOCE"

A value from the DeliveryLocationType vocabulary indicating the type of location.

• Restricted to values [1,8,9]

The Coded with Code System datatype flavour is used to carry this information as follows:

• The code attribute will contain the appropriate value from the DeliveryLocationType vocabulary
• The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.17.173"

Link to the entity representing the place of birth.

The role of the person notifying the authorities of the birth.

Indicates that the role is that of an entity acting in the employ of an Organization

• Fixed value: "ASSIGNED" (Assigned entity)

The entity assigned to play the role of notifier.

The person playing the role of Notifier.

A code indicating that the target entity is a Person

• Fixed value: "PSN"

Indicates that this is an actual instance of the entity, and not a general description of a class of entity

• Fixed value: "INSTANCE"

The name of the notifier.

The PN datatype will be of the flavour Person Name structured and contain exactly one <family/> element, and one or two <given/> elements.

The role of the responsible child health authority.

Indicates that the role is that of an entity acting in the employ of an Organization

• Fixed value: "ASSIGNED" (Assigned entity)

The identifier of the assigned organisation acting as the responsible child health authority.

The Identifier External datatype flavour is used to carry this information as follows:

• The root attribute will contain an OID with the value "1.2.826.0.1285.0.1.10"
• The extension attribute will contain the NHS SDS Organisation Id

The role of a partner child health authority.

Indicates that the role is that of an entity acting in the employ of an Organization

• Fixed value: "ASSIGNED" (Assigned entity)

The identifier of the assigned organisation acting as the partner child health authority.

The Identifier External datatype flavour is used to carry this information as follows:

• The root attribute will contain an OID with the value "1.2.826.0.1285.0.1.10"
• The extension attribute will contain the NHS SDS Organisation Id

The role of the Mother.

A code indicating that the role is that of a Patient

• Fixed value: "PAT"

The current nationally recognised identifier for the patient. This identifier will be:

• NHS number;

The Identifier External datatype flavour is used to carry this information as follows:-

A NHS number is carried in the following way:

• The root attribute will contain an OID with the value "2.16.840.1.113883.2.1.4.1";
• The extension attribute will contain the NHS number itself.

The entity playing the role of mother.

Targets the Mother as the subject of PrimaryCareProvision

Indicates that the target Role is the subject of the Act

• Fixed Value : "SBJ"

A link to details of patient care provision given by a health care provider.

The Entity playing the role of Mother.

A code indicating that the entity is a Person

• Fixed value: "PSN"

Indicates that this is an actual instance of the entity, and not a general description of a class of entity

• Fixed value: "INSTANCE"

The date of birth of the MotherPerson expressed at the precision of the date.

The name of the mother.

The PN datatype will be of the flavour Person Name structured and contain exactly one <family/> element, and one or two <given/> elements.

The act of provision of primary care to the mother.

Signifies that this is an act of patient care provision.

• Fixed value "PCPR"

Indicates this is an event.

• Fixed value: "EVN" (Event)

Coded value from the PatientCareProvisionType vocabulary.

The Coded with Code System datatype flavour is used to carry this information as follows:

• The code attribute will contain the appropriate value from the PatientCareProvisionType vocabulary
  • Fixed value : "1" (Primary Care)
• The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.17.37"

The effective dates for the care provision relationship represented as a range, supplied in the low and high sub-elements. Both the low and high sub-elements are optional, allowing open-ended ranges to be specified.

The effective from date (the low sub-element) must not be in the future.

NB The business effective date for all data being added to the PDS that has an associated business effective date must always be provided. In this case, the effectiveTime attribute should be used wherever possible.

Indicates the performer of the PrimaryCareProvision.

Indicates that the participation is that of a Performer

• Fixed value : "PRF"

The role of Primary Care Provider.

An Entity (player) that is authorized to provide health care services by some authorizing agency (scoper).

The identifier of the assigned organisation acting as health care provider. This will be :

• GP Practice Code - where the PatientCareProvisionType is "1" (Primary Care)

The Identifier External datatype flavour is used to carry this information as follows:

• The root attribute will contain an OID with the value "2.16.840.1.113883.2.1.4.3"
• The extension attribute will contain the GP Practice Code