HL7 v2+ Specification
0.0.0 - draft

HL7 v2+ Specification, published by HL7 International. This guide is not an authorized publication; it is the continuous build for version 0.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/v2ig/ and changes regularly. See the Directory of published versions

Logical Model: HL7 v2 PPN Data Type

Official URL: http://hl7.org/v2/StructureDefinition/PPN Version: 0.0.0
Standards status: Informative Computable Name: PPN

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from V2ComplexDataType

NameFlagsCard.TypeDescription & Constraintsdoco
.. PPN 0..* V2ComplexDataType performing person time stamp
Instances of this logical model are not marked to be the target of a Reference
... 1 0..1 string Person Identifier
... 2 0..1 FN Family Name
... 3 0..1 string Given Name
... 5 0..1 string Suffix
... 6 0..1 string Prefix
... 7 Degree
... 8 Source Table
Binding: http://terminology.hl7.org/ValueSet/v2-0297 (required)
... 9 0..1 HD Assigning Authority
Binding: http://terminology.hl7.org/ValueSet/v2-0363 (required)
... 10 0..1 code Name Type Code
Binding: hl7VS-nameType (required)
... 11 0..1 string Identifier Check Digit
... 12 0..1 code Check Digit Scheme
Binding: hl7VS-checkDigitScheme (required)
... 13 0..1 code Identifier Type Code
Binding: hl7VS-identifierType (required)
... 14 0..1 HD Assigning Facility
... 15 0..1 dateTime Date/Time Action Performed
... 16 0..1 code Name Representation Code
Binding: hl7VS-name-addressRepresentation (required)
... 17 0..1 CWE Name Context
Binding: http://terminology.hl7.org/ValueSet/v2-0448 (required)
... 18 Name Validity Range
... 19 0..1 code Name Assembly Order
Binding: hl7VS-nameAssemblyOrder (required)
... 20 0..1 dateTime Effective Date
... 21 0..1 dateTime Expiration Date
... 22 0..1 string Professional Suffix
... 23 0..1 CWE Assigning Jurisdiction
... 24 0..1 CWE Assigning Agency or Department
... 25 0..1 string Security Check
... 26 0..1 code Security Check Scheme
Binding: hl7VS-securityCheckScheme (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
PPN.8requiredhttp://terminology.hl7.org/ValueSet/v2-0297
http://terminology.hl7.org/ValueSet/v2-0297
PPN.9requiredhttp://terminology.hl7.org/ValueSet/v2-0363
http://terminology.hl7.org/ValueSet/v2-0363
PPN.10requiredHl7VSNameType
http://terminology.hl7.org/ValueSet/v2-0200
PPN.12requiredHl7VSCheckDigitScheme
http://terminology.hl7.org/ValueSet/v2-0061
PPN.13requiredHl7VSIdentifierType
http://terminology.hl7.org/ValueSet/v2-0203
PPN.16requiredHl7VSNameAddressRepresentation
http://terminology.hl7.org/ValueSet/v2-0465
PPN.17requiredhttp://terminology.hl7.org/ValueSet/v2-0448
http://terminology.hl7.org/ValueSet/v2-0448
PPN.19requiredHl7VSNameAssemblyOrder
http://terminology.hl7.org/ValueSet/v2-0444
PPN.26requiredHl7VSSecurityCheckScheme
http://terminology.hl7.org/ValueSet/v2-0904
NameFlagsCard.TypeDescription & Constraintsdoco
.. PPN 0..* V2ComplexDataType performing person time stamp
Instances of this logical model are not marked to be the target of a Reference
... 1 0..1 string Person Identifier
... 2 0..1 FN Family Name
... 3 0..1 string Given Name
... 5 0..1 string Suffix
... 6 0..1 string Prefix
... 7 Degree
... 8 Source Table
Binding: http://terminology.hl7.org/ValueSet/v2-0297 (required)
... 9 0..1 HD Assigning Authority
Binding: http://terminology.hl7.org/ValueSet/v2-0363 (required)
... 10 0..1 code Name Type Code
Binding: hl7VS-nameType (required)
... 11 0..1 string Identifier Check Digit
... 12 0..1 code Check Digit Scheme
Binding: hl7VS-checkDigitScheme (required)
... 13 0..1 code Identifier Type Code
Binding: hl7VS-identifierType (required)
... 14 0..1 HD Assigning Facility
... 15 0..1 dateTime Date/Time Action Performed
... 16 0..1 code Name Representation Code
Binding: hl7VS-name-addressRepresentation (required)
... 17 0..1 CWE Name Context
Binding: http://terminology.hl7.org/ValueSet/v2-0448 (required)
... 18 Name Validity Range
... 19 0..1 code Name Assembly Order
Binding: hl7VS-nameAssemblyOrder (required)
... 20 0..1 dateTime Effective Date
... 21 0..1 dateTime Expiration Date
... 22 0..1 string Professional Suffix
... 23 0..1 CWE Assigning Jurisdiction
... 24 0..1 CWE Assigning Agency or Department
... 25 0..1 string Security Check
... 26 0..1 code Security Check Scheme
Binding: hl7VS-securityCheckScheme (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PPN.8requiredhttp://terminology.hl7.org/ValueSet/v2-0297
http://terminology.hl7.org/ValueSet/v2-0297
PPN.9requiredhttp://terminology.hl7.org/ValueSet/v2-0363
http://terminology.hl7.org/ValueSet/v2-0363
PPN.10requiredHl7VSNameType
http://terminology.hl7.org/ValueSet/v2-0200
PPN.12requiredHl7VSCheckDigitScheme
http://terminology.hl7.org/ValueSet/v2-0061
PPN.13requiredHl7VSIdentifierType
http://terminology.hl7.org/ValueSet/v2-0203
PPN.16requiredHl7VSNameAddressRepresentation
http://terminology.hl7.org/ValueSet/v2-0465
PPN.17requiredhttp://terminology.hl7.org/ValueSet/v2-0448
http://terminology.hl7.org/ValueSet/v2-0448
PPN.19requiredHl7VSNameAssemblyOrder
http://terminology.hl7.org/ValueSet/v2-0444
PPN.26requiredHl7VSSecurityCheckScheme
http://terminology.hl7.org/ValueSet/v2-0904
NameFlagsCard.TypeDescription & Constraintsdoco
.. PPN 0..* V2ComplexDataType performing person time stamp
Instances of this logical model are not marked to be the target of a Reference
... 1 0..1 string Person Identifier
... 2 0..1 FN Family Name
... 3 0..1 string Given Name
... 5 0..1 string Suffix
... 6 0..1 string Prefix
... 7 Degree
... 8 Source Table
Binding: http://terminology.hl7.org/ValueSet/v2-0297 (required)
... 9 0..1 HD Assigning Authority
Binding: http://terminology.hl7.org/ValueSet/v2-0363 (required)
... 10 0..1 code Name Type Code
Binding: hl7VS-nameType (required)
... 11 0..1 string Identifier Check Digit
... 12 0..1 code Check Digit Scheme
Binding: hl7VS-checkDigitScheme (required)
... 13 0..1 code Identifier Type Code
Binding: hl7VS-identifierType (required)
... 14 0..1 HD Assigning Facility
... 15 0..1 dateTime Date/Time Action Performed
... 16 0..1 code Name Representation Code
Binding: hl7VS-name-addressRepresentation (required)
... 17 0..1 CWE Name Context
Binding: http://terminology.hl7.org/ValueSet/v2-0448 (required)
... 18 Name Validity Range
... 19 0..1 code Name Assembly Order
Binding: hl7VS-nameAssemblyOrder (required)
... 20 0..1 dateTime Effective Date
... 21 0..1 dateTime Expiration Date
... 22 0..1 string Professional Suffix
... 23 0..1 CWE Assigning Jurisdiction
... 24 0..1 CWE Assigning Agency or Department
... 25 0..1 string Security Check
... 26 0..1 code Security Check Scheme
Binding: hl7VS-securityCheckScheme (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PPN.8requiredhttp://terminology.hl7.org/ValueSet/v2-0297
http://terminology.hl7.org/ValueSet/v2-0297
PPN.9requiredhttp://terminology.hl7.org/ValueSet/v2-0363
http://terminology.hl7.org/ValueSet/v2-0363
PPN.10requiredHl7VSNameType
http://terminology.hl7.org/ValueSet/v2-0200
PPN.12requiredHl7VSCheckDigitScheme
http://terminology.hl7.org/ValueSet/v2-0061
PPN.13requiredHl7VSIdentifierType
http://terminology.hl7.org/ValueSet/v2-0203
PPN.16requiredHl7VSNameAddressRepresentation
http://terminology.hl7.org/ValueSet/v2-0465
PPN.17requiredhttp://terminology.hl7.org/ValueSet/v2-0448
http://terminology.hl7.org/ValueSet/v2-0448
PPN.19requiredHl7VSNameAssemblyOrder
http://terminology.hl7.org/ValueSet/v2-0444
PPN.26requiredHl7VSSecurityCheckScheme
http://terminology.hl7.org/ValueSet/v2-0904

This structure is derived from V2ComplexDataType

Summary

Differential View

This structure is derived from V2ComplexDataType

NameFlagsCard.TypeDescription & Constraintsdoco
.. PPN 0..* V2ComplexDataType performing person time stamp
Instances of this logical model are not marked to be the target of a Reference
... 1 0..1 string Person Identifier
... 2 0..1 FN Family Name
... 3 0..1 string Given Name
... 5 0..1 string Suffix
... 6 0..1 string Prefix
... 7 Degree
... 8 Source Table
Binding: http://terminology.hl7.org/ValueSet/v2-0297 (required)
... 9 0..1 HD Assigning Authority
Binding: http://terminology.hl7.org/ValueSet/v2-0363 (required)
... 10 0..1 code Name Type Code
Binding: hl7VS-nameType (required)
... 11 0..1 string Identifier Check Digit
... 12 0..1 code Check Digit Scheme
Binding: hl7VS-checkDigitScheme (required)
... 13 0..1 code Identifier Type Code
Binding: hl7VS-identifierType (required)
... 14 0..1 HD Assigning Facility
... 15 0..1 dateTime Date/Time Action Performed
... 16 0..1 code Name Representation Code
Binding: hl7VS-name-addressRepresentation (required)
... 17 0..1 CWE Name Context
Binding: http://terminology.hl7.org/ValueSet/v2-0448 (required)
... 18 Name Validity Range
... 19 0..1 code Name Assembly Order
Binding: hl7VS-nameAssemblyOrder (required)
... 20 0..1 dateTime Effective Date
... 21 0..1 dateTime Expiration Date
... 22 0..1 string Professional Suffix
... 23 0..1 CWE Assigning Jurisdiction
... 24 0..1 CWE Assigning Agency or Department
... 25 0..1 string Security Check
... 26 0..1 code Security Check Scheme
Binding: hl7VS-securityCheckScheme (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
PPN.8requiredhttp://terminology.hl7.org/ValueSet/v2-0297
http://terminology.hl7.org/ValueSet/v2-0297
PPN.9requiredhttp://terminology.hl7.org/ValueSet/v2-0363
http://terminology.hl7.org/ValueSet/v2-0363
PPN.10requiredHl7VSNameType
http://terminology.hl7.org/ValueSet/v2-0200
PPN.12requiredHl7VSCheckDigitScheme
http://terminology.hl7.org/ValueSet/v2-0061
PPN.13requiredHl7VSIdentifierType
http://terminology.hl7.org/ValueSet/v2-0203
PPN.16requiredHl7VSNameAddressRepresentation
http://terminology.hl7.org/ValueSet/v2-0465
PPN.17requiredhttp://terminology.hl7.org/ValueSet/v2-0448
http://terminology.hl7.org/ValueSet/v2-0448
PPN.19requiredHl7VSNameAssemblyOrder
http://terminology.hl7.org/ValueSet/v2-0444
PPN.26requiredHl7VSSecurityCheckScheme
http://terminology.hl7.org/ValueSet/v2-0904

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PPN 0..* V2ComplexDataType performing person time stamp
Instances of this logical model are not marked to be the target of a Reference
... 1 0..1 string Person Identifier
... 2 0..1 FN Family Name
... 3 0..1 string Given Name
... 5 0..1 string Suffix
... 6 0..1 string Prefix
... 7 Degree
... 8 Source Table
Binding: http://terminology.hl7.org/ValueSet/v2-0297 (required)
... 9 0..1 HD Assigning Authority
Binding: http://terminology.hl7.org/ValueSet/v2-0363 (required)
... 10 0..1 code Name Type Code
Binding: hl7VS-nameType (required)
... 11 0..1 string Identifier Check Digit
... 12 0..1 code Check Digit Scheme
Binding: hl7VS-checkDigitScheme (required)
... 13 0..1 code Identifier Type Code
Binding: hl7VS-identifierType (required)
... 14 0..1 HD Assigning Facility
... 15 0..1 dateTime Date/Time Action Performed
... 16 0..1 code Name Representation Code
Binding: hl7VS-name-addressRepresentation (required)
... 17 0..1 CWE Name Context
Binding: http://terminology.hl7.org/ValueSet/v2-0448 (required)
... 18 Name Validity Range
... 19 0..1 code Name Assembly Order
Binding: hl7VS-nameAssemblyOrder (required)
... 20 0..1 dateTime Effective Date
... 21 0..1 dateTime Expiration Date
... 22 0..1 string Professional Suffix
... 23 0..1 CWE Assigning Jurisdiction
... 24 0..1 CWE Assigning Agency or Department
... 25 0..1 string Security Check
... 26 0..1 code Security Check Scheme
Binding: hl7VS-securityCheckScheme (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PPN.8requiredhttp://terminology.hl7.org/ValueSet/v2-0297
http://terminology.hl7.org/ValueSet/v2-0297
PPN.9requiredhttp://terminology.hl7.org/ValueSet/v2-0363
http://terminology.hl7.org/ValueSet/v2-0363
PPN.10requiredHl7VSNameType
http://terminology.hl7.org/ValueSet/v2-0200
PPN.12requiredHl7VSCheckDigitScheme
http://terminology.hl7.org/ValueSet/v2-0061
PPN.13requiredHl7VSIdentifierType
http://terminology.hl7.org/ValueSet/v2-0203
PPN.16requiredHl7VSNameAddressRepresentation
http://terminology.hl7.org/ValueSet/v2-0465
PPN.17requiredhttp://terminology.hl7.org/ValueSet/v2-0448
http://terminology.hl7.org/ValueSet/v2-0448
PPN.19requiredHl7VSNameAssemblyOrder
http://terminology.hl7.org/ValueSet/v2-0444
PPN.26requiredHl7VSSecurityCheckScheme
http://terminology.hl7.org/ValueSet/v2-0904

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PPN 0..* V2ComplexDataType performing person time stamp
Instances of this logical model are not marked to be the target of a Reference
... 1 0..1 string Person Identifier
... 2 0..1 FN Family Name
... 3 0..1 string Given Name
... 5 0..1 string Suffix
... 6 0..1 string Prefix
... 7 Degree
... 8 Source Table
Binding: http://terminology.hl7.org/ValueSet/v2-0297 (required)
... 9 0..1 HD Assigning Authority
Binding: http://terminology.hl7.org/ValueSet/v2-0363 (required)
... 10 0..1 code Name Type Code
Binding: hl7VS-nameType (required)
... 11 0..1 string Identifier Check Digit
... 12 0..1 code Check Digit Scheme
Binding: hl7VS-checkDigitScheme (required)
... 13 0..1 code Identifier Type Code
Binding: hl7VS-identifierType (required)
... 14 0..1 HD Assigning Facility
... 15 0..1 dateTime Date/Time Action Performed
... 16 0..1 code Name Representation Code
Binding: hl7VS-name-addressRepresentation (required)
... 17 0..1 CWE Name Context
Binding: http://terminology.hl7.org/ValueSet/v2-0448 (required)
... 18 Name Validity Range
... 19 0..1 code Name Assembly Order
Binding: hl7VS-nameAssemblyOrder (required)
... 20 0..1 dateTime Effective Date
... 21 0..1 dateTime Expiration Date
... 22 0..1 string Professional Suffix
... 23 0..1 CWE Assigning Jurisdiction
... 24 0..1 CWE Assigning Agency or Department
... 25 0..1 string Security Check
... 26 0..1 code Security Check Scheme
Binding: hl7VS-securityCheckScheme (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PPN.8requiredhttp://terminology.hl7.org/ValueSet/v2-0297
http://terminology.hl7.org/ValueSet/v2-0297
PPN.9requiredhttp://terminology.hl7.org/ValueSet/v2-0363
http://terminology.hl7.org/ValueSet/v2-0363
PPN.10requiredHl7VSNameType
http://terminology.hl7.org/ValueSet/v2-0200
PPN.12requiredHl7VSCheckDigitScheme
http://terminology.hl7.org/ValueSet/v2-0061
PPN.13requiredHl7VSIdentifierType
http://terminology.hl7.org/ValueSet/v2-0203
PPN.16requiredHl7VSNameAddressRepresentation
http://terminology.hl7.org/ValueSet/v2-0465
PPN.17requiredhttp://terminology.hl7.org/ValueSet/v2-0448
http://terminology.hl7.org/ValueSet/v2-0448
PPN.19requiredHl7VSNameAssemblyOrder
http://terminology.hl7.org/ValueSet/v2-0444
PPN.26requiredHl7VSSecurityCheckScheme
http://terminology.hl7.org/ValueSet/v2-0904

This structure is derived from V2ComplexDataType

Summary

 

Other representations of profile: CSV, Excel