HL7 - REFACTORED

18.8.26 CER - Certificate Detail Segment (15.4.2)

The CER segment adds detailed information regarding the formal authorizations to provide a service (e.g. licenses, certificates) held by the health professional identified by the STF segment.

HL7 Attribute Table - CER - Certificate Detail

Segment (new)
(base framework)
Segment (new)
(w/o profiles)
Segment (new)
(w/ profiles)
Segment (classic)
(w/ profiles)
Segment (classic)
(w/o profiles)
FHIR
Structure Definition
v2.xml
XSD

Base Framework
	Seq#	Data Element	Description	Flags	Implement	Cardinality	Length	C.LEN	Vocabulary	Data Type
CER
	1	01856	Set ID - CER		SHOULD	[1..1]	[1..4]			SI Sequence ID
	2	01857	Serial Number	= Truncation not allowed!	MAY	[0..1]		80		ST String Data
	3	01858	Version	= Truncation not allowed!	MAY	[0..1]		80		ST String Data
	4	01859	Granting Authority		MAY	[0..1]				XON Extended Composite Name and Identification Number for Organizations
	5	01860	Issuing Authority		MAY	[0..1]				XCN Extended Composite ID Number and Name for Persons
	6	01861	Signature		MAY	[0..1]				ED Encapsulated Data
	7	01862	Granting Country		MAY	[0..1]	[3..3]			ID Coded Value for HL7 Defined Tables
	8	01863	Granting State/Province		MAY	[0..1]			ex.:CountrySubdivision (CD)	CWE Coded with Exceptions
	9	01864	Granting County/Parish		MAY	[0..1]			County/Parish (CD)	CWE Coded with Exceptions
	10	01865	Certificate Type		MAY	[0..1]				CWE Coded with Exceptions
	11	01866	Certificate Domain		MAY	[0..1]				CWE Coded with Exceptions
	12	01867	Subject ID	C Condition defined for this element	MAY	[0..1]				EI Entity Identifier
	13	01907	Subject Name	= Truncation not allowed!	SHOULD	[1..1]		250		ST String Data
	14	01868	Subject Directory Attribute Extension		MAY	[0..*]				CWE Coded with Exceptions
	15	01869	Subject Public Key Info		MAY	[0..1]				CWE Coded with Exceptions
	16	01870	Authority Key Identifier		MAY	[0..1]				CWE Coded with Exceptions
	17	01871	Basic Constraint		MAY	[0..1]	[1..1]		univ: Yes/noIndicator (CD) hl7VS-yes-no-Indicator (VS) expandedYes-NoIndicator (CS)	ID Coded Value for HL7 Defined Tables
	18	01872	CRL Distribution Point		MAY	[0..*]				CWE Coded with Exceptions
	19	01875	Jurisdiction Country		MAY	[0..1]	[3..3]			ID Coded Value for HL7 Defined Tables
	20	01873	Jurisdiction State/Province		MAY	[0..1]			ex.:CountrySubdivision (CD)	CWE Coded with Exceptions
	21	01874	Jurisdiction County/Parish		MAY	[0..1]			County/Parish (CD)	CWE Coded with Exceptions
	22	01895	Jurisdiction Breadth		MAY	[0..*]			ex.:JurisdictionalBreadth (CD)	CWE Coded with Exceptions
	23	01876	Granting Date		MAY	[0..1]				DTM Date/Time
	24	01877	Issuing Date		MAY	[0..1]				DTM Date/Time
	25	01878	Activation Date		MAY	[0..1]				DTM Date/Time
	26	01879	Inactivation Date		MAY	[0..1]				DTM Date/Time
	27	01880	Expiration Date		MAY	[0..1]				DTM Date/Time
	28	01881	Renewal Date		MAY	[0..1]				DTM Date/Time
	29	01882	Revocation Date		MAY	[0..1]				DTM Date/Time
	30	01883	Revocation Reason Code		MAY	[0..1]				CWE Coded with Exceptions
	31	01884	Certificate Status Code		MAY	[0..1]			repr: CertificateStatus (CD)	CWE Coded with Exceptions

Conditions/Invariants

The root for the expression is on the segment.

Seq.	Referenced Elements	Introduction	Invariant	Comment
1		?

	Seq#	Data Element	Description	Flags	Implement	Cardinality	Length	C.LEN	Vocabulary	Data Type
CER
	1	01856	Set ID - CER		SHALL	[1..1]	[1..4]			SI Sequence ID
	2	01857	Serial Number	= Truncation not allowed!	MAY	[0..1]		80		ST String Data
	3	01858	Version	= Truncation not allowed!	MAY	[0..1]		80		ST String Data
	4	01859	Granting Authority		MAY	[0..1]				XON Extended Composite Name and Identification Number for Organizations
	5	01860	Issuing Authority		MAY	[0..1]				XCN Extended Composite ID Number and Name for Persons
	6	01861	Signature		MAY	[0..1]				ED Encapsulated Data
	7	01862	Granting Country		MAY	[0..1]	[3..3]			ID Coded Value for HL7 Defined Tables
	8	01863	Granting State/Province		MAY	[0..1]			ex.:CountrySubdivision (CD)	CWE Coded with Exceptions
	9	01864	Granting County/Parish		MAY	[0..1]			County/Parish (CD)	CWE Coded with Exceptions
	10	01865	Certificate Type		MAY	[0..1]				CWE Coded with Exceptions
	11	01866	Certificate Domain		MAY	[0..1]				CWE Coded with Exceptions
	12	01867	Subject ID	C Condition defined for this element	MAY	[0..1]				EI Entity Identifier
	13	01907	Subject Name	= Truncation not allowed!	SHALL	[1..1]		250		ST String Data
	14	01868	Subject Directory Attribute Extension		MAY	[0..*]				CWE Coded with Exceptions
	15	01869	Subject Public Key Info		MAY	[0..1]				CWE Coded with Exceptions
	16	01870	Authority Key Identifier		MAY	[0..1]				CWE Coded with Exceptions
	17	01871	Basic Constraint		MAY	[0..1]	[1..1]		univ: Yes/noIndicator (CD) hl7VS-yes-no-Indicator (VS) expandedYes-NoIndicator (CS)	ID Coded Value for HL7 Defined Tables
	18	01872	CRL Distribution Point		MAY	[0..*]				CWE Coded with Exceptions
	19	01875	Jurisdiction Country		MAY	[0..1]	[3..3]			ID Coded Value for HL7 Defined Tables
	20	01873	Jurisdiction State/Province		MAY	[0..1]			ex.:CountrySubdivision (CD)	CWE Coded with Exceptions
	21	01874	Jurisdiction County/Parish		MAY	[0..1]			County/Parish (CD)	CWE Coded with Exceptions
	22	01895	Jurisdiction Breadth		MAY	[0..*]			ex.:JurisdictionalBreadth (CD) hl7VS-jurisdictionalBreadth (VS) jurisdictionalBreadth (CS)	CWE Coded with Exceptions
	23	01876	Granting Date		MAY	[0..1]				DTM Date/Time
	24	01877	Issuing Date		MAY	[0..1]				DTM Date/Time
	25	01878	Activation Date		MAY	[0..1]				DTM Date/Time
	26	01879	Inactivation Date		MAY	[0..1]				DTM Date/Time
	27	01880	Expiration Date		MAY	[0..1]				DTM Date/Time
	28	01881	Renewal Date		MAY	[0..1]				DTM Date/Time
	29	01882	Revocation Date		MAY	[0..1]				DTM Date/Time
	30	01883	Revocation Reason Code		MAY	[0..1]				CWE Coded with Exceptions
	31	01884	Certificate Status Code		MAY	[0..1]			repr: CertificateStatus (CD) hl7VS-certificateStatus (VS) certificateStatus (CS)	CWE Coded with Exceptions

Base Framework											Base Standard Profile
	Seq#	Data Element	Description	Flags	Implement	Cardinality	Length	C.LEN	Vocabulary	Data Type	Implement	Vocabulary
CER
	1	01856	Set ID - CER		SHOULD	[1..1]	[1..4]			SI Sequence ID	SHALL
	2	01857	Serial Number	= Truncation not allowed!	MAY	[0..1]		80		ST String Data	MAY
	3	01858	Version	= Truncation not allowed!	MAY	[0..1]		80		ST String Data	MAY
	4	01859	Granting Authority		MAY	[0..1]				XON Extended Composite Name and Identification Number for Organizations	MAY
	5	01860	Issuing Authority		MAY	[0..1]				XCN Extended Composite ID Number and Name for Persons	MAY
	6	01861	Signature		MAY	[0..1]				ED Encapsulated Data	MAY
	7	01862	Granting Country		MAY	[0..1]	[3..3]			ID Coded Value for HL7 Defined Tables	MAY
	8	01863	Granting State/Province		MAY	[0..1]			ex.:CountrySubdivision (CD)	CWE Coded with Exceptions	MAY
	9	01864	Granting County/Parish		MAY	[0..1]			County/Parish (CD)	CWE Coded with Exceptions	MAY
	10	01865	Certificate Type		MAY	[0..1]				CWE Coded with Exceptions	MAY
	11	01866	Certificate Domain		MAY	[0..1]				CWE Coded with Exceptions	MAY
	12	01867	Subject ID	C Condition defined for this element	MAY	[0..1]				EI Entity Identifier	MAY
	13	01907	Subject Name	= Truncation not allowed!	SHOULD	[1..1]		250		ST String Data	SHALL
	14	01868	Subject Directory Attribute Extension		MAY	[0..*]				CWE Coded with Exceptions	MAY
	15	01869	Subject Public Key Info		MAY	[0..1]				CWE Coded with Exceptions	MAY
	16	01870	Authority Key Identifier		MAY	[0..1]				CWE Coded with Exceptions	MAY
	17	01871	Basic Constraint		MAY	[0..1]	[1..1]		univ: Yes/noIndicator (CD) hl7VS-yes-no-Indicator (VS) expandedYes-NoIndicator (CS)	ID Coded Value for HL7 Defined Tables	MAY
	18	01872	CRL Distribution Point		MAY	[0..*]				CWE Coded with Exceptions	MAY
	19	01875	Jurisdiction Country		MAY	[0..1]	[3..3]			ID Coded Value for HL7 Defined Tables	MAY
	20	01873	Jurisdiction State/Province		MAY	[0..1]			ex.:CountrySubdivision (CD)	CWE Coded with Exceptions	MAY
	21	01874	Jurisdiction County/Parish		MAY	[0..1]			County/Parish (CD)	CWE Coded with Exceptions	MAY
	22	01895	Jurisdiction Breadth		MAY	[0..*]			ex.:JurisdictionalBreadth (CD)	CWE Coded with Exceptions	MAY	hl7VS-jurisdictionalBreadth (VS) jurisdictionalBreadth (CS)
	23	01876	Granting Date		MAY	[0..1]				DTM Date/Time	MAY
	24	01877	Issuing Date		MAY	[0..1]				DTM Date/Time	MAY
	25	01878	Activation Date		MAY	[0..1]				DTM Date/Time	MAY
	26	01879	Inactivation Date		MAY	[0..1]				DTM Date/Time	MAY
	27	01880	Expiration Date		MAY	[0..1]				DTM Date/Time	MAY
	28	01881	Renewal Date		MAY	[0..1]				DTM Date/Time	MAY
	29	01882	Revocation Date		MAY	[0..1]				DTM Date/Time	MAY
	30	01883	Revocation Reason Code		MAY	[0..1]				CWE Coded with Exceptions	MAY
	31	01884	Certificate Status Code		MAY	[0..1]			repr: CertificateStatus (CD)	CWE Coded with Exceptions	MAY	hl7VS-certificateStatus (VS) certificateStatus (CS)

Base Framework											Base Standard Profile
	Seq#	Data Element	Description	Flags	Optionality	Repetition	Length	C.LEN	Table	Data Type	Optionality	Table
CER
	1	01856	Set ID - CER		O		[1..4]			SI Sequence ID	R
	2	01857	Serial Number		O			80=		ST String Data
	3	01858	Version		O			80=		ST String Data
	4	01859	Granting Authority		O					XON Extended Composite Name and Identification Number for Organizations
	5	01860	Issuing Authority		O					XCN Extended Composite ID Number and Name for Persons
	6	01861	Signature		O					ED Encapsulated Data
	7	01862	Granting Country		O		[3..3]			ID Coded Value for HL7 Defined Tables		(0399)
	8	01863	Granting State/Province		O					CWE Coded with Exceptions		(0347)
	9	01864	Granting County/Parish		O					CWE Coded with Exceptions		(0289)
	10	01865	Certificate Type		O					CWE Coded with Exceptions
	11	01866	Certificate Domain		O					CWE Coded with Exceptions
	12	01867	Subject ID	C Condition defined for this element	O					EI Entity Identifier
	13	01907	Subject Name		O			250=		ST String Data	R
	14	01868	Subject Directory Attribute Extension		O	Y				CWE Coded with Exceptions
	15	01869	Subject Public Key Info		O					CWE Coded with Exceptions
	16	01870	Authority Key Identifier		O					CWE Coded with Exceptions
	17	01871	Basic Constraint		O		[1..1]			ID Coded Value for HL7 Defined Tables		(0136)
	18	01872	CRL Distribution Point		O	Y				CWE Coded with Exceptions
	19	01875	Jurisdiction Country		O		[3..3]			ID Coded Value for HL7 Defined Tables		(0399)
	20	01873	Jurisdiction State/Province		O					CWE Coded with Exceptions		(0347)
	21	01874	Jurisdiction County/Parish		O					CWE Coded with Exceptions		(0289)
	22	01895	Jurisdiction Breadth		O	Y				CWE Coded with Exceptions		(0547)
	23	01876	Granting Date		O					DTM Date/Time
	24	01877	Issuing Date		O					DTM Date/Time
	25	01878	Activation Date		O					DTM Date/Time
	26	01879	Inactivation Date		O					DTM Date/Time
	27	01880	Expiration Date		O					DTM Date/Time
	28	01881	Renewal Date		O					DTM Date/Time
	29	01882	Revocation Date		O					DTM Date/Time
	30	01883	Revocation Reason Code		O					CWE Coded with Exceptions
	31	01884	Certificate Status Code		O					CWE Coded with Exceptions		(0536)

	Seq#	Data Element	Description	Optionality	Repetition	Length	C.LEN	Table	Data Type
CER
	1	01856	Set ID - CER	R		[1..4]			SI Sequence ID
	2	01857	Serial Number	O			80=		ST String Data
	3	01858	Version	O			80=		ST String Data
	4	01859	Granting Authority	O					XON Extended Composite Name and Identification Number for Organizations
	5	01860	Issuing Authority	O					XCN Extended Composite ID Number and Name for Persons
	6	01861	Signature	O					ED Encapsulated Data
	7	01862	Granting Country	O		[3..3]		(0399)	ID Coded Value for HL7 Defined Tables
	8	01863	Granting State/Province	O				(0347)	CWE Coded with Exceptions
	9	01864	Granting County/Parish	O				(0289)	CWE Coded with Exceptions
	10	01865	Certificate Type	O					CWE Coded with Exceptions
	11	01866	Certificate Domain	O					CWE Coded with Exceptions
	12	01867	Subject ID	C					EI Entity Identifier
	13	01907	Subject Name	R			250=		ST String Data
	14	01868	Subject Directory Attribute Extension	O	Y				CWE Coded with Exceptions
	15	01869	Subject Public Key Info	O					CWE Coded with Exceptions
	16	01870	Authority Key Identifier	O					CWE Coded with Exceptions
	17	01871	Basic Constraint	O		[1..1]		(0136)	ID Coded Value for HL7 Defined Tables
	18	01872	CRL Distribution Point	O	Y				CWE Coded with Exceptions
	19	01875	Jurisdiction Country	O		[3..3]		(0399)	ID Coded Value for HL7 Defined Tables
	20	01873	Jurisdiction State/Province	O				(0347)	CWE Coded with Exceptions
	21	01874	Jurisdiction County/Parish	O				(0289)	CWE Coded with Exceptions
	22	01895	Jurisdiction Breadth	O	Y			(0547)	CWE Coded with Exceptions
	23	01876	Granting Date	O					DTM Date/Time
	24	01877	Issuing Date	O					DTM Date/Time
	25	01878	Activation Date	O					DTM Date/Time
	26	01879	Inactivation Date	O					DTM Date/Time
	27	01880	Expiration Date	O					DTM Date/Time
	28	01881	Renewal Date	O					DTM Date/Time
	29	01882	Revocation Date	O					DTM Date/Time
	30	01883	Revocation Reason Code	O					CWE Coded with Exceptions
	31	01884	Certificate Status Code	O				(0536)	CWE Coded with Exceptions

18.8.26.1 CER - Field Definitions (15.4.2.0)

18.8.26.2 CER-1 Set ID - CER (SI) 01856 (15.4.2.1)

Definition: This field contains the number that identifies this transaction. For the first occurrence of the segment, the sequence number shall be one; for the second occurrence, the sequence number shall be two; etc.

18.8.26.3 CER-2 Serial Number (ST) 01857 (15.4.2.2)

Definition: The serial number uniquely identifies the attribute certificate within the scope of its issuer. This field contains the number and/or characters that identify the certificate held by the health professional.

An attribute certificate is a data structure which certifies (either digitally or manually) that one or more attributes (e.g., descriptors, capabilities, qualifications, etc.) are associated with a particular entity as verified/certified by the attribute authority (e.g., Credentialing Organization (US), Physician Chamber "�rztekammer" (D), Physicians Statutory Association "Kassen�rztliche Vereinigung" (D)).

18.8.26.4 CER-3 Version (ST) 01858 (15.4.2.3)

Definition: The version number differentiates among different versions of the attribute certificate.

18.8.26.5 CER-4 Granting Authority (XON) 01859 (15.4.2.4)

Definition: It specifies the authority that granted the certificate to the person.

18.8.26.6 CER-5 Issuing Authority (XCN) 01860 (15.4.2.5)

Definition: Specifies the authority that issued the certificate to the person.

18.8.26.7 CER-6 Signature (ED) 01861 (15.4.2.6)

Definition: Digital Signature of the certifying authority. The Digital Signature includes a seal concept and is verifiable.

18.8.26.8 CER-7 Granting Country (ID) 01862 (15.4.2.7)

Definition: ID of the country granting the certificate. Refer to External Table 0399 - Country Code for valid values.

18.8.26.9 CER-8 Granting State/Province (CWE) 01863 (15.4.2.8)

Definition: State/province granting the certificate. Refer to User-defined Table 0347 - State/Province for valid values (in Chapter 2)

18.8.26.10 CER-9 Granting County/Parish (CWE) 01864 (15.4.2.9)

Definition: County/parish granting the certificate. Refer to User-defined Table 0289 - County/Parish for valid values (in Chapter 2).

18.8.26.11 CER-10 Certificate Type (CWE) 01865 (15.4.2.10)

Definition: This field specifies the certificate's classification, e.g., being a privilege, permission, or qualification certificate.

18.8.26.12 CER-11 Certificate Domain (CWE) 01866 (15.4.2.11)

Definition: This field specifies the subject area to which the certificate is applicable, e.g., administrative, medical, or nursing issues.

18.8.26.13 CER-12 Subject ID (EI) 01867 (15.4.2.12)

Definition: This field expresses the identifier of the certificate's subject as used by the certifying body. (The subject is the owner of the certificate, e.g., person, organization, device, application, component.) If the certificate is expressed as a X.509 document this field is required.

18.8.26.14 CER-13 Subject Name (ST) 01907 (15.4.2.13)

Definition: This field defines the name of the subject of the certificate as used by the certifying body.

18.8.26.15 CER-14 Subject Directory Attribute Extension (CWE) 01868 (15.4.2.14)

Definition: In individual identity certificates, this Subject Directory Attribute extension MAY contain a Healthcare Professional Role attribute and may contain a Qualified Certificate Statement attribute. In addition, Subject Directory Attributes MAY contain other attributes not specified by this technical specification.

18.8.26.16 CER-15 Subject Public Key Info (CWE) 01869 (15.4.2.15)

Definition: This field contains the algorithm identifier. Referred to this field, the X.509 extension field MAY contain a Subject Public Key Identifier to identify the public key used in the Subject Public Key Info.

X.509 is an ISO standard specifying certificates.

18.8.26.17 CER-16 Authority Key Identifier (CWE) 01870 (15.4.2.16)

Definition: The Authority Key Identifier extension SHALL identify the public key to be used to verify the signature of the certificate. It enables distinct keys, used by one CA, to be distinguished (e.g., as key updating occurs).

18.8.26.18 CER-17 Basic Constraint (ID) 01871 (15.4.2.17)

Definition: The Basic Constraints extension contains a boolean used to specify whether or not the subject can act as a CA (certificate authority), using the certified key to sign certificates.

18.8.26.19 CER-18 CRL Distribution Point (CWE) 01872 (15.4.2.18)

Definition: The Certificate Revocation List (CRL) Distribution Point extension SHALL identify the location of the associated CRL (or Authority Revocation List (ARL) for attribute certificates) in the PKI directory.

18.8.26.20 CER-19 Jurisdiction Country (ID) 01875 (15.4.2.19)

Definition: This field contains the country for which the qualification is valid. Refer to External Table 0399 - Country Code for valid values.

18.8.26.21 CER-20 Jurisdiction State/Province (CWE) 01873 (15.4.2.20)

Definition: This field contains the state for which the qualification is valid. HL7 suggests using values in User-defined Table 0347 - State/Province.

18.8.26.22 CER-21 Jurisdiction County/Parish (CWE) 01874 (15.4.2.21)

Definition: This field contains the county/parish for which the qualification is valid. HL7 suggests using values in User-defined Table 0289 - County/Parish.

18.8.26.23 CER-22 Jurisdiction Breadth (CWE) 01895 (15.4.2.22)

Definition: This field contains the breadth/extent of the jurisdiction where the qualification is valid. HL7 suggests using values in User-defined Table 0547 - Jurisdictional Breadth.

Refer to User-defined Table 0547 - Jurisdictional Breadth in Chapter 2C, Code Tables, for valid values. This table contains values for County, Parish, County etc.

18.8.26.24 CER-23 Granting Date (DTM) 01876 (15.4.2.23)

Definition: This field contains the date when the certificate was granted.

18.8.26.25 CER-24 Issuing Date (DTM) 01877 (15.4.2.24)

Definition: This field contains the date/time when the certificate was issued.

18.8.26.26 CER-25 Activation Date (DTM) 01878 (15.4.2.25)

Definition: This field contains the date/time when the certificate became or will become active.

18.8.26.27 CER-26 Inactivation Date (DTM) 01879 (15.4.2.26)

Definition: This field contains the date/time when the certificate became or will become inactive.

18.8.26.28 CER-27 Expiration Date (DTM) 01880 (15.4.2.27)

Definition: This field contains the date/time when the certificate expires or will expire.

18.8.26.29 CER-28 Renewal Date (DTM) 01881 (15.4.2.28)

Definition: This field contains the date/time when the certificate must/will/ be / has been renewed.

18.8.26.30 CER-29 Revocation date (DTM) 01882 (15.4.2.29)

Definition: This field contains the date/time when the certificate has been revoked.

18.8.26.31 CER-30 Revocation Reason Code (CWE) 01883 (15.4.2.30)

Definition: This field contains the reason for revoking the certificate (e.g., having been compromised, changes of conditions/environment, etc.)

18.8.26.32 CER-31 Certificate Status Code (CWE) 01884 (15.4.2.31)

Definition: This field contains the state of the certificate held by the health professional, such as provisional, revoked, etc. Refer to User-defined Table 0536 - Certificate Status in Chapter 2C, Code Tables, for suggested values.