Common and supporting types referenced in this specification are included here as a reference.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
adapterFingerprintListType | List | |||
adapterFingerprint | OR | An opaque marker that represents the amalgam of all underlying PODs tied to a specific DataProcessor-DataController relationship. | xs:normalizedString |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
aliasesType | List | |||
alias | MR | aliasType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
aliasType | ||||
code | M | codeType | ||
source | O | URL where the related abbreviation comes from. | uriType | |
namespace | O | Namespace where the related abbreviation comes from. | uriType |
Alternate purposes for which the data may be used.
Figure A.4-1: alternatePurposeListTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
alternatePurposeListType | Alternate purposes for which the data may be used. | List | ||
alternatePurpose | OR | Alternate purpose for which the data may be used. | xs:normalizedString |
List of application identifiers.
Figure A.5-1: appIDListTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
appIDListType | List of application identifiers. | List | ||
appID | OR | An application identifier. | xs:normalizedString |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
applicationInfoType | ||||
applicationKey | O | An opaque (to the SIF standard) element which contains any required Consumer authentication information. The content of this element is site-specific. For a Direct Environment which accepts Consumer Registration Requests from a mobile application, this element might contain a combination of the User ID and Password. | xs:string | |
supportedInfrastructureVersion | O | The version of the SIF infrastructure which the Consumer supports. | xs:string | |
dataModelNamespace | O | The namespace of the data payloads conveyed by this environment. Returns may be of a diffrent minor version. Utility payloads will be of the infrastructure namespace. | xs:anyURI | |
transport | O | The transport which the Consumer expects the infrastructure to use to interoperate with it. The default is whichever transport the create request was issued on | xs:string | |
applicationProduct | O | productIdentityType | ||
adapterProduct | O | productIdentityType |
A List of benchmarks - where a benchmark is a set of technical or process standards to ensure the clause is met.
Figure A.7-1: benchmarkListTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
benchmarkListType | A List of benchmarks - where a benchmark is a set of technical or process standards to ensure the clause is met. | List | ||
benchmark | OR | A benchmark is a set of technical or process standards to ensure the clause is met. | benchmarkType |
A set of technical or process standards to ensure the clause is met.
Figure A.8-1: benchmarkTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
benchmarkType | A set of technical or process standards to ensure the clause is met. | |||
benchmarkName | O | The name of the Benchmark | xs:normalizedString | |
benchmarkId | O | The local id of the benchmark. | gCoreLocalIdType | |
benchmarkDescription | O | A description of what the benchmark is and how it should be applied. | xs:normalizedString | |
benchmarkURL | O | A link to any authoritative source of the benchmark. | xs:anyURI |
A list of the legal clauses within the contract.
Figure A.9-1: clauseListTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
clauseListType | A list of the legal clauses within the contract. | List | ||
clause | OR | Details of a legal clause within the contract. | clauseType |
Details of a legal clause within the contract.
Figure A.10-1: clauseTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
clauseType | Details of a legal clause within the contract. | |||
clauseLabel | O | The label which should include a brief description. | xs:normalizedString | |
clauseReference | O | The formal clause reference. | xs:normalizedString | |
clauseContent | O | The actual detailed content of the clause. | xs:normalizedString | |
obligationList | O | List of obligations. | obligationListType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
codeItemsType | List | |||
codeItem | MR | codeItemType |
Element/@Attribute | Char | Description | Type | |||||
---|---|---|---|---|---|---|---|---|
codeItemType | ||||||||
code | M | Official abbreviation for the given value. | xs:string | |||||
source | O | URL where the related abbreviation comes from. | uriType | |||||
namespace | O | Namespace where the related abbreviation comes from. | uriType | |||||
value | M | What the code represents. | xs:token
| |||||
description | O | Human readable explanation of what the code represents. | xs:normalizedString
| |||||
definition | O | Human readable explanation provided by the source! | xs:normalizedString
| |||||
aliases | O | aliasesType | ||||||
action | M | The last action to be taken for this code item. | values:
| |||||
timestamp | M | The date and time of the last action taken on this code item. So that only updates can be queried efficiently (where applicable). | xs:dateTime |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
codeType | ||||
old | M | Indicates the alias code has been deprecated or deleted, even if it no longer appears in the register. | xs:boolean | |
official | M | Indicates the alias code is an official one; however the locale uses this one to represent that concept, at least in part. | xs:boolean | |
value | M | Alternate abbreviation that might need to be more specific or correct. | xs:string |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
conditionListType | List | |||
condition | OR | conditionType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
conditionType | ||||
typeOfCondition | O | xs:normalizedString | ||
conditionName | O | xs:normalizedString | ||
conditionDescription | O | xs:normalizedString | ||
propertyList | O | propertyNVListType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
contractType | O | The details of the contract the POD has been derived from. | ||
contractURI | M | URI Associated with contract | xs:anyURI | |
contractName | M | Name associated with contract | xs:normalizedString | |
dateValidFrom | M | Date the contract is valid from. | xs:date | |
dateValidTo | O | Date the contract is valid to. | xs:date | |
contractVersion | O | Version of contract that this POD applies to. | xs:normalizedString | |
lawList | M | List of laws covered referenced by the contract. | lawListType | |
studentDataIPRights | O | Who owns the IP rights of this contract? | xs:normalizedString |
List of impacted countries in or through which the data transits or is stored.
Figure A.17-1: countryImpactedListTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
countryImpactedListType | List of impacted countries in or through which the data transits or is stored. | List | ||
countryImpacted | OR | Name of a country impacted in or through which the data transits or is stored. | countryImpactedType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
countryImpactedType | ||||
country | O | Name of a country impacted in or through which the data transits or is stored. | gCoreCountryType | |
usage | O | Details of the usage within the country, how the data is handled e.g. stored permanently, operational store, back-up, archived, etc. | xs:normalizedString |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
createsType | List | |||
create | MR | createType |
Element/@Attribute | Char | Description | Type | |||
---|---|---|---|---|---|---|
createType | ||||||
@ | id | O | xs:token | |||
@ | advisoryId | M | xs:token | |||
@ | statusCode | O | xs:token
| |||
error | O | errorType |
A list of the data that can be accessed and any rules that specifically apply.
Figure A.21-1: dataAccessTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
dataAccessType | A list of the data that can be accessed and any rules that specifically apply. | |||
clauseList | O | A list of clauses that specifically apply to these technical requirements. | clauseListType | |
fieldList | O | A list of fields that can be accessed under this POD. Equivalent to a "green list". | fieldListType |
The data controller, "means the natural or legal person, public authority, agency or other body which, alone or jointly with others, determines the purposes and means of the processing of personal data", see GDPR.
Figure A.22-1: dataControllerTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
dataControllerType | The data controller, "means the natural or legal person, public authority, agency or other body which, alone or jointly with others, determines the purposes and means of the processing of personal data", see GDPR. | |||
dataControllerName | O | Name of the data controller. | xs:normalizedString | |
privacyPolicyURL | M | URL Associated with contract | xs:anyURI | |
privacyContactList | O | The details of the privacy contact. | gCoreContactListType | |
issuesNotificationContactList | O | The details of the individual to be contacted if there are issues in fulfilling the obligations of the contract. | gCoreContactListType |
Details and requirements for data deletion.
Figure A.23-1: dataDeletionTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
dataDeletionType | Details and requirements for data deletion. | |||
deleteData | O | Must data be deleted when no longer required to the primary purpose? | values:
| |
dataRetention | O | If allowed, how long can the data be retained for when no longer required for the primary purpose? | xs:integer | |
deleteBy | O | By which specific date should this data be removed from systems? | xs:date | |
partyToDeleteData | O | Who is responsible for deletion of this data? | partyToDeleteDataType | |
respondInDays | O | In how many days should any request for information around this data and it's deletion be responded to? | xs:integer | |
requirePortability | O | Do all the rules surrounding this data need to be ported with any data that is transmeitted? | values:
|
The data processor, "means a natural or legal person, public authority, agency or other body which processes personal data on behalf of the controller", see GDPR.
Figure A.24-1: dataProcessorTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
dataProcessorType | The data processor, "means a natural or legal person, public authority, agency or other body which processes personal data on behalf of the controller", see GDPR. | |||
dataProcessorName | O | Name of the Data Processor. | xs:normalizedString | |
privacyPolicyURL | M | URL Associated with contract | xs:anyURI | |
privacyContactList | O | The details of the privacy contact. | gCoreContactListType | |
notifyDataControllerOnAccessRequests | O | Do we need to advise the data controller of access requests? | values:
| |
dataProcessorContactForAccessRequestsList | O | The details of the person to contact for access requests. | gCoreContactListType | |
purposeList | O | A list or purposes for which the data may be used. | purposeListType | |
alternatePurposeList | O | Alternate purposes for which the data may be used. | alternatePurposeListType | |
deidentifiedPurposeList | O | The purposes for which deidentified data is able to be used (if any). | deidentifiedPurposeListType | |
dataUsageMarketingAllowed | O | Can the data be used for marketing purposes? | values:
| |
personalInformationUpdatedFromSource | O | The frequency at which personal information is to be updated from source systems. | xs:integer | |
dataBreachNotification | O | In the event there is a breach event is notification of the breach contact required? | values:
| |
dataBreachContactList | O | Contact details for the individual/s to be notified in the event of a data breach. | gCoreContactListType | |
employeesMustComplyWithAgreement | O | Must employees of the data controller comply the with agreement? | values:
| |
employeeConfidentialityAgreement | O | Are employees of the data controller required to comply with a confidentiality agreement? | values:
| |
employeeTrainingList | O | A list of the data controller employee’s training requirements. | employeeTrainingListType | |
passwordEmployeeAccessStandard | O | A list of the data controller employee’s password access standards. | passwordEmployeeAccessStandardType | |
securityTestRequiredList | O | A list of security testing required to be completed by the data controller. | securityTestRequiredListType | |
countryImpactedList | O | List of impacted countries in or through which the data transits or is stored. | countryImpactedListType |
The specific clauses obligations and benchmarks that applies to the subject - teacher, student or parent.
Figure A.25-1: dataSubjectTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
dataSubjectType | The specific clauses obligations and benchmarks that applies to the subject - teacher, student or parent. | |||
clauseList | O | clauseListType | ||
benchmarkList | O | benchmarkListType | ||
fieldList | O | A list of fields that can be accessed under this POD. Equivalent to a "green list". | fieldListType | |
respondInDays | O | n how many days should any request for information around this data subject be responded to? | xs:integer | |
requirePortability | O | Do all the rules surrounding this data need to be ported with any data that is transmeitted? | values:
|
The list of data sub-Processors who are the bodies that process data on behalf of the Data Processor.
Figure A.26-1: dataSubProcessorListTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
dataSubProcessorListType | The list of data sub-Processors who are the bodies that process data on behalf of the Data Processor. | List | ||
dataSubProcessor | OR | A data sub-Processors who are the bodies that process data on behalf of the Data Processor. | dataSubProcessorType |
Details of organisations who process data on behalf of the data processor.
Figure A.27-1: dataSubProcessorTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
dataSubProcessorType | Details of organisations who process data on behalf of the data processor. | |||
subProcessorName | O | Name of the sub processor. | xs:normalizedString | |
privacyPolicyURL | M | URL Associated with contract | xs:anyURI | |
privacyContactList | O | Details of the data sub processor's privacy contact. | gCoreContactListType | |
purposeList | O | The purpose for which data is supplied to the data sub processor by the data processor. | purposeListType |
Zone identifiers are chosen by the administrator and can follow any convention that best meets the needs of the deploying organization. The Zone in which the Service is to be found always qualifies every Consumer request for any Provider Service. Each Service Consumer is assigned a "default" Zone at Registration time, which is used whenever a specific Zone is not explicitly included in one of its Provider Service Requests.
Figure A.28-1: defaultZoneTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
defaultZoneType | Zone identifiers are chosen by the administrator and can follow any convention that best meets the needs of the deploying organization. The Zone in which the Service is to be found always qualifies every Consumer request for any Provider Service. Each Service Consumer is assigned a "default" Zone at Registration time, which is used whenever a specific Zone is not explicitly included in one of its Provider Service Requests. | |||
@ | id | O | xs:token | |
description | O | A short (possibly multi-sentence) description of the Zone | xs:normalizedString | |
properties | O | propertiesType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
DefinedProtocolsType | The transport protocols defined in SIF. | values:
|
The purposes for which deidentified data is able to be used (if any).
Figure A.30-1: deidentifiedPurposeListTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
deidentifiedPurposeListType | The purposes for which deidentified data is able to be used (if any). | List | ||
deidentifiedPurpose | OR | The purpose for which deidentified data is able to be used (if any). | xs:normalizedString |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
deleteIdCollectionType | List | |||
delete | MR | deleteIdType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
deleteIdType | EMPTY | |||
@ | id | M | xs:token |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
deleteStatusCollectionType | List | |||
delete | MR | deleteStatusType |
Element/@Attribute | Char | Description | Type | |||
---|---|---|---|---|---|---|
deleteStatusType | ||||||
@ | id | O | xs:token | |||
@ | statusCode | O | xs:token
| |||
error | O | errorType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
employeeTrainingListType | List | |||
employeeTraining | OR | employeeTrainingType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
employeeTrainingType | ||||
trainingName | O | xs:normalizedString | ||
trainingURL | O | xs:anyURI |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
endpointListType | List | |||
endpoint | OR | An endpoint covered by the POD. | endpointType |
A type of endpoint.
Figure A.38-1: endpointTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
endpointType | A type of endpoint. | |||
endpointURL | O | The url of the endpoint. | xs:anyURI | |
endpointProviderName | O | The name of the provider of the endpoint. | xs:normalizedString |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
enumerationsType | List | |||
enumeration | MR | Individual setting | enumerationType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
enumerationType | ||||
value | M | An acceptable parameter value for this query. | xs:token | |
code | C | If enumerated value has an equivalent code, this field may be used for conversion. | xs:token |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
environmentTypeType | O | values:
|
A list of fields that can be accessed under this POD. Equivalent to a "green list".
Figure A.43-1: fieldListTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
fieldListType | A list of fields that can be accessed under this POD. Equivalent to a "green list". | List | ||
field | OR | Details of a field that can be accessed under this POD, equivalent to an element in a "green list". | fieldType |
Details of a field that can be accessed under this POD, equivalent to an element in a "green list".
Figure A.44-1: fieldTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
fieldType | Details of a field that can be accessed under this POD, equivalent to an element in a "green list". | |||
fieldName | O | Name of the "green listed field" | xs:normalizedString | |
controlrights | O | What are the control rights around this "green listed field"? | values:
|
A list of Address elements.
Figure A.45-1: gCoreAddressListTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
gCoreAddressListType | A list of Address elements. | List | ||
address | MR | Extension of gCoreAddressType |
This element contains address data
Figure A.46-1: gCoreAddressTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
gCoreAddressType | M | This element contains address data. | ||
effectiveFromDate | O | Date the address became active. | xs:date | |
effectiveToDate | O | Date the address ceases to be active. | xs:date | |
line1 | M | Address line 1. | xs:normalizedString | |
line2 | O | Address line 2. | xs:normalizedString | |
line3 | O | Address line 3. | xs:normalizedString | |
city | M | The city or Suburb part of the address. | xs:normalizedString | |
stateProvince | C | The state or province or county. | gCoreStateProvinceType | |
country | O | The country code. | gCoreCountryType | |
postalCode | M | The ZIP/postal code. | xs:normalizedString |
Common element used to supply information for a contact person at a school, LEA, or other institution.
Figure A.47-1: gCoreContactInfoTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
gCoreContactInfoType | Common element used to supply information for a contact person at a school, LEA, or other institution. | |||
name | M | gCoreNameType | ||
positionTitle | O | The contact person's position title. Examples | xs:normalizedString | |
role | O | Role played by this contact in this instance. Examples | xs:normalizedString | |
registrationDetails | O | Registration Details of the Contact. | xs:normalizedString | |
qualifications | O | Qualifications of the Contact. | xs:normalizedString | |
address | O | Address of the contact. | gCoreAddressType | |
emailList | O | List of Email elements. | gCoreEmailListType | |
phoneNumberList | O | List of PhoneNumber elements. | gCorePhoneNumberListType |
List of Contacts associated with an entity.
Figure A.48-1: gCoreContactListTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
gCoreContactListType | List of Contacts associated with an entity. | List | ||
contact | MR | gCoreContactInfoType |
A country code or name.
Figure A.49-1: gCoreCountryTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
gCoreCountryType | A country code or name. | xs:normalizedString |
A list of e-mail addresses associated with an individual or organization.
Figure A.50-1: gCoreEmailListTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
gCoreEmailListType | A list of e-mail addresses associated with an individual or organization. | List | ||
MR | gCoreEmailType |
This element represents an e-mail address of one of a number of types and occurs in objects such as StudentPersonal, StaffPersonal, StudentContactPersonal, etc..
Figure A.51-1: gCoreEmailTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
gCoreEmailType | M | This element represents an e-mail address of one of a number of types and occurs in objects such as StudentPersonal, StaffPersonal, StudentContactPersonal, etc.. | xs:normalizedString |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
gCoreGenderType | values:
|
This is a common element used to define the locally assigned identifier associated with an entity.
Figure A.53-1: gCoreLocalIdTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
gCoreLocalIdType | This is a common element used to define the locally assigned identifier associated with an entity. | xs:normalizedString |
Core Name Type or Name
elements, primarily to allow structure to be leveraged with different Type
attribute values.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
gCoreNameType |
Core Name Type or | |||
title | O | A title or prefix associated with the name. If any of: Mr, Mrs, Ms, Miss, Rev, Fr, Dr, Prof, Hon, Sir, Lord, Lady - these must be as shown, otherwise free text. Note that title is not applicable to learners. | xs:normalizedString | |
familyName | C | Family name. That part of the person's name which is used to describe family, clan, tribal group, or marital association. Note that this element is required when known. However, it may not be possible to know the family name in which case you should add the available information to the FullName element. | xs:normalizedString | |
givenName | C | Given name of the person. Note that this element is required if known. However, it may not be possible to know the given name in which case you should add the available information to the FullName element. | xs:normalizedString | |
otherGivenNames | O | All other given or middle names, each separated with a single space character. | xs:normalizedString | |
familyNameFirst | O | An indicator used to identify the naming conventions used by some predominantly non-European, ethnic or language groups and related to the display nature of a name. | values:
| |
preferredName | O | The given name preferred most by the person (as written). | xs:normalizedString |
Lists phone numbers associated with an entity.
Figure A.55-1: gCorePhoneNumberListTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
gCorePhoneNumberListType | Lists phone numbers associated with an entity. | List | ||
phoneNumber | MR | gCorePhoneNumberType |
This element represents a phone number and occurs within objects such as StudentPersonal, StaffPersonal, etc.
Figure A.56-1: gCorePhoneNumberTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
gCorePhoneNumberType | This element represents a phone number and occurs within objects such as StudentPersonal, StaffPersonal, etc. | |||
number | M | Phone number. Free-form, but typical Australian formats include:
| xs:normalizedString | |
extension | O | Phone number extension. | xs:normalizedString | |
listedStatus | O | Indicates whether or not the phone number is available to the public. | values:
| |
preference | O | Preference number indicating an order in which phone numbers should be used when contacting person. | xs:unsignedInt |
The identifier for this entity as assigned by the state or province.
Figure A.57-1: gCoreStateProvinceIdTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
gCoreStateProvinceIdType | The identifier for this entity as assigned by the state or province. | xs:normalizedString |
A state or province code. Note: When dealing with countries other than Australia, state/province codes/values other than those referenced here can be used.
Figure A.58-1: gCoreStateProvinceTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
gCoreStateProvinceType | A state or province code. Note: When dealing with countries other than Australia, state/province codes/values other than those referenced here can be used. | xs:normalizedString |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
infrastructureServiceNamesType | O | values:
|
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
infrastructureServicesType | List | |||
infrastructureService | MR | There must be an InfrastructureService element present for each defined Infrastructure Service. The value of each InfrastructureService Property value subelement defines the URL location of that Infrastructure Service. | infrastructureServiceType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
infrastructureServiceType | xs:normalizedString | |||
@ | name | O | infrastructureServiceNamesType values:
|
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
initializationType | ||||
phaseName | O | Name of initialization phase the payload corresponds to. | xs:token | |
payload | M | Information matching the initialization phase, should result in corresponding phase having an INPROGRESS, COMPLETED, or FAILED state. | xs:anyType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
jobStateType | O | values:
|
A list of parties and data sharing permissions.
Figure A.64-1: lawListTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
lawListType | A list of parties and data sharing permissions. | List | ||
law | OR | A law that applies to this contract. | lawType |
Information about the specific law.
Figure A.65-1: lawTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
lawType | Information about the specific law. | |||
lawName | M | Common name for this law. | xs:normalizedString | |
lawDescription | M | Details of the law. | xs:normalizedString |
Contains a list of the legal clauses within the contract.
Figure A.66-1: legalRequirementsTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
legalRequirementsType | Contains a list of the legal clauses within the contract. | |||
clauseList | M | A list of the legal clauses within the contract. | clauseListType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
mediaTypesType | List | |||
mediaType | MR | An Internet Media Type supported by this adaptor (for this service). | xs:token |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
methodParametersType | List | |||
methodParameter | MR | Individual setting | methodParameterType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
methodParameterType | ||||
paramName | M | The name of the parameter being passed in. | xs:token | |
paramValue | M | The value of the parameter being passed in. | xs:normalizedString | |
comparisonType | O | The operation used to make the comparison. If not provided EQUAL is assumed. | xs:token |
A list of requirements imposed by the contract.
Figure A.70-1: obligationListTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
obligationListType | A list of requirements imposed by the contract. | List | ||
obligation | OR | A requirement imposed by the contract. | obligationType |
A requirement imposed by the contract.
Figure A.71-1: obligationTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
obligationType | A requirement imposed by the contract. | |||
obligationDescription | O | A description of the requirment imposed by the contract. | xs:normalizedString | |
obligationURL | O | A link to any authoritative source of the obligation. | xs:anyURI | |
benchmarkList | O | A list of benchmarks associated with the obligation. | benchmarkListType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
parametersType | List | |||
parameter | OR | Individual setting | parameterType |
Element/@Attribute | Char | Description | Type | |||||
---|---|---|---|---|---|---|---|---|
parameterType | ||||||||
name | M | The name of the query parameter to be passed in. Note: Must not conflict with any other query parameter name. | xs:token | |||||
type | O | A well understood type that MAY be used for parameter validation. Example: xs:unsignedInt. | xs:token | |||||
default | O | Value to be supplied for this parameter if the submitter omits it. | xs:token | |||||
description | O | An explanation of what this parameter represents. | xs:normalizedString
| |||||
required | O | Indicator as to if this parameter is required. If omitted, the parameter is assumed to be required!. | xs:boolean | |||||
enumerations | O | enumerationsType | ||||||
range | O | rangeType | ||||||
minLength | O | The minimum length for values of this parameter. If omitted, zero. May be functionally different because of other restrictions. | xs:unsignedInt | |||||
maxLength | O | The maximum length for values of this parameter. If omitted, unbounded. May be functionally different because of other restrictions. | xs:unsignedInt |
Who is responsible for deletion of this data?
Figure A.74-1: partyToDeleteDataTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
partyToDeleteDataType | Who is responsible for deletion of this data? | |||
organisation | O | gCoreLocalIdType | ||
deletecontactInfo | O | gCoreContactInfoType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
passwordEmployeeAccessStandardType | ||||
standardName | O | Name of the standard used for access. | xs:normalizedString | |
standardURL | O | A link to an authoritative source for this standard. | xs:anyURI |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
phaseCollectionType | List | |||
phase | MR | phaseType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
phaseStateType | O | values:
|
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
phaseType | ||||
name | M | The name of the Phase unique within the context of the owning job. | xs:token | |
states | M | A collection of the states the Phase has been through, must initially contain a NOTAPPLICABLE or NOTSTARTED state. | stateCollectionType | |
required | M | Whether or not this phase is required for the job to complete successfully. | xs:boolean | |
rights | M | Access rights given to the consumer for this phase. | rightsType | |
statesRights | M | Access rights given to the consumer for each state. | rightsType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
privacyListType | List | |||
privacy | OR | privacyType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
privacyObligationsDocumentType | ||||
contract | O | The details of the contract the POD has been derived from. | contractType | |
legalRequirements | O | Legal Requirements Container. | legalRequirementsType | |
technicalRequirements | O | Technical Requirements Container. | technicalRequirementsType | |
dataController | O | The data controller, "means the natural or legal person, public authority, agency or other body which, alone or jointly with others, determines the purposes and means of the processing of personal data", see GDPR. | dataControllerType | |
dataProcessor | O | The data processor, "means a natural or legal person, public authority, agency or other body which processes personal data on behalf of the controller", see GDPR. | dataProcessorType | |
dataSubProcessorList | O | The list of data sub-Processors who are the bodies that process data on behalf of the Data Processor. | dataSubProcessorListType |
.
Figure A.81-1: privacyTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
privacyType | . | |||
default | M | Is this the default privacy template? | values:
| |
appIDList | O | The list of applications in this contract. | appIDListType | |
adapterFingerprintList | O | A list of fingerprints. | adapterFingerprintListType | |
zoneContextList | O | A list zones and contexts where this POD applies. | zoneContextListType | |
endpointList | O | A list of endpoints that are covered by this POD. | endpointListType | |
dataModelNamespace | O | Namespace associated with the relevant datamodel. | xs:anyURI | |
dataModelVersionMin | O | Minimum data model version. | xs:normalizedString | |
dataModelVersionMax | O | Maximum data model version. | xs:normalizedString | |
privacyObligationsDocument | O | The legal and technical requirements that are required to be met to satisfy privacy and security concerns. | privacyObligationsDocumentType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
productIdentityType | ||||
vendorName | O | The name of the company supplying this Product. | xs:string | |
productName | M | The name of the Product | xs:string | |
productVersion | O | The format of this field is undefined, but it should match the format used in the agent's conformance statement, if the agent is SIF Certified. | xs:string | |
iconURI | O | HTTP URL referencing an icon for graphical representation of the application/agent. Should range from 16x16 pixels to 128x128 pixels and be of an image MIME type commonly supported by Web browsers (e.g. PNG, JPEG, GIF). | xs:anyURI |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
propertiesType | List | |||
property | MR | Individual setting | propertyType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
propertyNVListType | List | |||
property | OR | propertyNVType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
propertyNVType | ||||
propertyName | O | xs:normalizedString | ||
propertyValue | O | xs:normalizedString |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
propertyType | xs:normalizedString | |||
@ | name | M | Name/Value pair. | xs:string |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
protocolType | ||||
location | M | The URL to use when sending Requests to a Provider | xs:anyURI | |
properties | O | May contain zero or more property elements containing name/value pairs describing any protocol settings required to ensure proper communication | propertiesType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
provisionedZonesType | List | |||
provisionedZone | MR | A specific Zone defined for this environment. | provisionedZoneType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
provisionedZoneType | ||||
@ | id | M | The unique id of the Zone, and the key to the Zone element in the Zone Registry. | xs:string |
services | O | servicesType |
A list of the purposes for which data is may be used.
Figure A.90-1: purposeListTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
purposeListType | A list of the purposes for which data is may be used. | List | ||
purpose | OR | The purpose for which data may be used. | xs:normalizedString |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
querySupportType | ||||
dynamicQuery | O | True if this service is capable of honoring the "where" parameter. | xs:boolean | |
queryByExample | O | True if this service is capable of honoring query by example payloads. | xs:boolean | |
changesSinceMarker | O | True if this service is capable of supporting Changes Since Queries. | xs:boolean | |
paged | O | True if this service is capable of responding to Paged Query Requests (both Interactive and Batch). | xs:boolean | |
maxPageSize | C | If Paged Queries are supported, this is the maximum number of Objects that will be returned on a Page of Query results. | xs:unsignedInt | |
totalCount | O | xs:boolean | ||
applicationProduct | C | Application Vendor Identification | productIdentityType | |
adapterProduct | O | Adapter Vendor Identification | productIdentityType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
rangeType | ||||
start | M | If a numeric range is used, this holds the inclusive starting value. | xs:long | |
end | M | If a numeric range is used, this holds the inclusive ending value. | xs:long |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
rightsType | List | |||
right | MR | rightType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
rightType | Extension of rightValueType values:
| |||
@ | type | M | The type of the requested Access Right | values:
|
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
rightValueType | rightValueType is the base type for the following data types: | values:
|
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
securityTechnologyListType | List | |||
securityTechnology | OR | securityTechnologyType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
securityTechnologyType | ||||
clauseList | O | clauseListType | ||
technologyName | O | xs:normalizedString | ||
technologyDescription | O | xs:normalizedString | ||
referenceURL | O | xs:anyURI | ||
versionMin | O | xs:normalizedString |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
securityTestRequiredListType | List | |||
securityTestRequired | OR | Details of the security test required. | securityTestRequiredType |
Details of the security test required.
Figure A.99-1: securityTestRequiredTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
securityTestRequiredType | Details of the security test required. | |||
testType | O | Type of the test. | xs:normalizedString | |
testFrequency | O | How often does this test need to be performed? | xs:normalizedString | |
remediationRequiredIn | O | RNumber of days remediation for any inadequacies has to be completed with in. | xs:normalizedString | |
shareResults | O | Are the results of this security test allowed to be shared? | values:
|
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
servicesType | List | |||
service | MR | serviceType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
serviceSubTypeType | O | values:
|
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
serviceType | ||||
@ | type | M | serviceTypeType values:
| |
@ | subType | O | serviceSubTypeType values:
| |
@ | name | M | The name of the Service. For utilities, this is fixed to one of the defined set of Utility Service Names. For objects and functions, it is defined by the Data Model. | xs:string |
@ | contextId | M | The unique identity of a context element, which is associated with a Provider of this name and type operating in a Zone with this ID. All Services with the same name in the same Zone must have different Context IDs. Only one such Service can have no Context. | xs:string |
rights | M | rightsType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
serviceTypeType | O | values:
|
Details of technical requirements that need to be met to achieve the POD.
Figure A.105-1: technicalRequirementsTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
technicalRequirementsType | Details of technical requirements that need to be met to achieve the POD. | |||
dataAccess | O | A list of the data that can be accessed and any rules that specifically apply. | dataAccessType | |
conditionList | O | conditionListType | ||
dataSubject | O | The specific clauses obligations and benchmarks that applies to the subject - teacher, student or parent. | dataSubjectType | |
dataDeletion | O | Details and requirements for data deletion. | dataDeletionType | |
securityTechnologyList | O | securityTechnologyListType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
updatesType | List | |||
update | MR | updateType |
Element/@Attribute | Char | Description | Type | |||
---|---|---|---|---|---|---|
updateType | ||||||
@ | id | O | xs:token | |||
@ | statusCode | O | xs:token
| |||
error | O | errorType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
uriType | O | xs:anyURI |
Element/@Attribute | Char | Description | Type | |||
---|---|---|---|---|---|---|
uuidType | O | xs:token
|
Element/@Attribute | Char | Description | Type | |||
---|---|---|---|---|---|---|
versionType | O | xs:token
|
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
zoneContextListType | List | |||
zoneContext | OR | zoneContextType |
A Zone and/or Context related to a POD.
Figure A.112-1: zoneContextTypeElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
zoneContextType | A Zone and/or Context related to a POD. | |||
zoneId | O | gCoreLocalIdType | ||
contextId | O | gCoreLocalIdType |