exchange-document

EPO Exchange Document: for the moment accommodates exchange of patent documents, including abstracts; in future to be extended to included images, full text and esp@cenet data. 
DOCDB/XML exchange makes use of natural language tags exclusively, SDOBI tags will not be used, data will be supplied in "bibliographic-data"

This xsd document relates to the exchange-document format version 2.4

Change History :
20060606 :  "classification-national" included; "star-indication" now Y/N switch "is-family-representative"; "abstract-accession-number" no longer supplied
20060626 : schema compressed into document dedicated to components related to DOCDB exchange only; IDT included, cited references included 
20070117 : "exch:related-documents" suppressed, not supported by DOCDB; enumeration "country" extended; designation of states for ARIPO and others
20070511 : new tag in  "dates-of-public-availability" : "modified-complete-spec-pub" for publication kind-codes A9 and B9
20070611 : extended with information on EPO simple patent family and family identifier in "exch:patent-family" and attribute "family-id"
20080520 : EPC 2000 - new tag "previously-filed-app" : previously filed application on EP publications, INID code 27
20100227 : ST50-republication : modified tag, in compliance with new release ICE definition
20100227 : References cited : new attribute "srep-office" on element "citation", new values attribute "srep-phase", attributes "dnum" and "dnum-type" on element "patcit" populated to cater for cited application
20100827 : Limited the cardinality of corresponding-docs to zero or one for simplification reasons (in practice there will be only one corresponding document)
20100827 : Use of complex type exch:document-idType instead of having the same definition repeated in the xsd file. 
20100827 : Unbounded occurrences of document-id in patcit, publication-reference, application-reference and priority-claim element, to support multiple number formats also for citations.
20100827 : Addition of document-id-type attribute in document-id to express the format the id is given in. This to support multiple number formats also for citations.
20100827 : Addition of sub sequence in citation element according to ST-36 standard (citation element can have unbounded amount of rel-passage, category and rel-claims elements; the rel-passage element can occur after the category and rel-claims elements it relates to)
20100907 : Addition of fields of search field according to ST-36 standard. This is to support consulted classifications during search.
20101015 : Enhancement of the cardinality of the classification-national field to unbounded occurances in order to express multiple national classifications
20110101 : "application-reference" - new attribute "doc-id" - surrogate key - unique and stable identifier
20110304 : "classification-ecla" iteration replaced by "patent-classifications" group covering multiple classification-schemes (ECLA, ICO, IDT, ECNO, DOCUS, FI, FTERM)
20110217 : Addition of doi element to non patent citations according to ST-36
20110223 : References cited: removed deprecated attribute "srep-phase" and introduced "cited-phase" and "cited-by" instead according to ST-36; update of possible phases for the "cited-phase" element according to Raul
20110627 : sub-elements of the locationType used in NPL citations are not mandatory
20110627 : Addition of the generic patent-classifications element inside of the field-of-search element
20110629 : Addition of the search-report-information element as proposed by the St.36 task force

Attributes used : 
    	country=publication-country, repeated in publication-reference;
    	date-added-DOCDB=date this document was first added to DOCDB;              
    	date-of-previous-exchange= date this document was previously exchanged;              
    	date-of-last-exchange=date this document was exchanged;
    	date-publ=publication-date, repeated in publication-reference;
    	doc-number=publication-number, repeated in publication-reference;
   	dtd-version=version of the DTD or schema used to validate this document instance;
   	file=file-name of the batch of exchange-documents this document belongs to, eg. DOCDB-yyyyww-PubDateyyyymmdd
   	is-representative=indicates whether or not the given publication is the "representative" of the publication cycle; typically out  of an A2 A3 B1 B2 sequence, the A2 publication will be marked as the representative one.  Value YES/NO;
   	kind=publication-kindcode, repeated in publication-reference;
    	status=reason why this publication was exchanged;  C  (new publication), D  (publication deleted), A (publication amended);CV(new publication "withdrawn": DV(publication "withdrawn" deleted)

Element Information

Model

Attributes

QName Type Fixed Default Use Inheritable Annotation
correction-code xs:string optional
country countryType required
date-added-docdb ICE-date-type optional
date-of-last-exchange ICE-date-type optional
date-of-previous-exchange ICE-date-type optional
date-produced ICE-date-type optional
date-publ ICE-date-type optional
doc-number xs:string optional
dtd-version xs:string optional
family-id xs:string optional
file xs:string optional
file-reference-id xs:string optional
id xs:ID optional
is-representative restriction of xs:string optional
kind xs:string optional
lang xs:language optional
originating-office countryType optional
status xs:string optional
system xs:string optional

Used By

Source

<xs:element name="exchange-document">
  <xs:annotation>
    <xs:documentation>EPO Exchange Document: for the moment accommodates exchange of patent documents, including abstracts; in future to be extended to included images, full text and esp@cenet data. DOCDB/XML exchange makes use of natural language tags exclusively, SDOBI tags will not be used, data will be supplied in "bibliographic-data" This xsd document relates to the exchange-document format version 2.4 Change History : 20060606 : "classification-national" included; "star-indication" now Y/N switch "is-family-representative"; "abstract-accession-number" no longer supplied 20060626 : schema compressed into document dedicated to components related to DOCDB exchange only; IDT included, cited references included 20070117 : "exch:related-documents" suppressed, not supported by DOCDB; enumeration "country" extended; designation of states for ARIPO and others 20070511 : new tag in "dates-of-public-availability" : "modified-complete-spec-pub" for publication kind-codes A9 and B9 20070611 : extended with information on EPO simple patent family and family identifier in "exch:patent-family" and attribute "family-id" 20080520 : EPC 2000 - new tag "previously-filed-app" : previously filed application on EP publications, INID code 27 20100227 : ST50-republication : modified tag, in compliance with new release ICE definition 20100227 : References cited : new attribute "srep-office" on element "citation", new values attribute "srep-phase", attributes "dnum" and "dnum-type" on element "patcit" populated to cater for cited application 20100827 : Limited the cardinality of corresponding-docs to zero or one for simplification reasons (in practice there will be only one corresponding document) 20100827 : Use of complex type exch:document-idType instead of having the same definition repeated in the xsd file. 20100827 : Unbounded occurrences of document-id in patcit, publication-reference, application-reference and priority-claim element, to support multiple number formats also for citations. 20100827 : Addition of document-id-type attribute in document-id to express the format the id is given in. This to support multiple number formats also for citations. 20100827 : Addition of sub sequence in citation element according to ST-36 standard (citation element can have unbounded amount of rel-passage, category and rel-claims elements; the rel-passage element can occur after the category and rel-claims elements it relates to) 20100907 : Addition of fields of search field according to ST-36 standard. This is to support consulted classifications during search. 20101015 : Enhancement of the cardinality of the classification-national field to unbounded occurances in order to express multiple national classifications 20110101 : "application-reference" - new attribute "doc-id" - surrogate key - unique and stable identifier 20110304 : "classification-ecla" iteration replaced by "patent-classifications" group covering multiple classification-schemes (ECLA, ICO, IDT, ECNO, DOCUS, FI, FTERM) 20110217 : Addition of doi element to non patent citations according to ST-36 20110223 : References cited: removed deprecated attribute "srep-phase" and introduced "cited-phase" and "cited-by" instead according to ST-36; update of possible phases for the "cited-phase" element according to Raul 20110627 : sub-elements of the locationType used in NPL citations are not mandatory 20110627 : Addition of the generic patent-classifications element inside of the field-of-search element 20110629 : Addition of the search-report-information element as proposed by the St.36 task force Attributes used : country=publication-country, repeated in publication-reference; date-added-DOCDB=date this document was first added to DOCDB; date-of-previous-exchange= date this document was previously exchanged; date-of-last-exchange=date this document was exchanged; date-publ=publication-date, repeated in publication-reference; doc-number=publication-number, repeated in publication-reference; dtd-version=version of the DTD or schema used to validate this document instance; file=file-name of the batch of exchange-documents this document belongs to, eg. DOCDB-yyyyww-PubDateyyyymmdd is-representative=indicates whether or not the given publication is the "representative" of the publication cycle; typically out of an A2 A3 B1 B2 sequence, the A2 publication will be marked as the representative one. Value YES/NO; kind=publication-kindcode, repeated in publication-reference; status=reason why this publication was exchanged; C (new publication), D (publication deleted), A (publication amended);CV(new publication "withdrawn": DV(publication "withdrawn" deleted)</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="exch:bibliographic-data"/>
      <xs:element ref="exch:abstract" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element ref="exch:patent-family" minOccurs="0"/>
    </xs:sequence>
    <xs:attribute name="correction-code" type="xs:string"/>
    <xs:attribute name="country" type="exch:countryType" use="required"/>
    <xs:attribute name="date-produced" type="exch:ICE-date-type"/>
    <xs:attribute name="date-added-docdb" type="exch:ICE-date-type"/>
    <xs:attribute name="date-of-previous-exchange" type="exch:ICE-date-type"/>
    <xs:attribute name="date-of-last-exchange" type="exch:ICE-date-type"/>
    <xs:attribute name="date-publ" type="exch:ICE-date-type"/>
    <xs:attribute name="doc-number" type="xs:string"/>
    <xs:attribute name="dtd-version" type="xs:string"/>
    <xs:attribute name="file" type="xs:string"/>
    <xs:attribute name="file-reference-id" type="xs:string"/>
    <xs:attribute name="id" type="xs:ID"/>
    <xs:attribute name="family-id" type="xs:string"/>
    <xs:attribute name="is-representative">
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="YES"/>
          <xs:enumeration value="NO"/>
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="kind" type="xs:string"/>
    <xs:attribute name="lang" type="xs:language"/>
    <xs:attribute name="originating-office" type="exch:countryType"/>
    <xs:attribute name="status" type="xs:string"/>
    <xs:attribute name="system" type="xs:string"/>
  </xs:complexType>
</xs:element>

Sample