Vital Records Death Reporting (VRDR) FHIR Implementation Guide
3.0.0 - STU3 United States of America flag

Vital Records Death Reporting (VRDR) FHIR Implementation Guide, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 3.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/vrdr/ and changes regularly. See the Directory of published versions

Resource Profile: Demographic Coded Content Bundle

Official URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/vrdr-demographic-coded-content-bundle Version: 3.0.0
Active as of 2024-10-16 Computable Name: DemographicCodedContentBundle
Other Identifiers: OID:2.16.840.1.113883.4.642.40.10.42.34

Demographic Coded Content Bundle (Bundle): A bundle containing instances of the resources comprising demographic (race and ethnicity) coded content.

This bundle is information-content equivalent to the traditional NCHS MRE format.

This bundle contains:

Mortality (Decedent)
Use Case # Description IJE Name Field Type Value Set/Comments
Mortality 3 Certificate Number FILENO identifier.extension[certificateNumber].value string(6) -
Mortality 5 Auxiliary State file number AUXNO identifier.extension[auxiliaryStateIdentifier1].value string(12) -
Mortality 121 Auxiliary State file number AUXNO2 identifier.extension[auxiliaryStateIdentifier2].value string(12) -
Mortality NA Death Record Identifier *NO IJE MAPPING* identifier.value string(12) YYYYJJNNNNNN, YYYY = death year JJ = jurisdiction and NNNNNN = certificate number

Usage:

Changes since version true:

  • No changes
  • Formal Views of Profile Content

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

    This structure is derived from Bundle

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Bundle 0..* Bundle Contains a collection of resources
    ... identifier 1..1 Identifier Persistent identifier for the bundle
    .... Slices for extension Content/Rules for all slices
    ..... certificateNumber 0..1 string Certificate Number
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CertificateNumber
    ..... auxiliaryStateIdentifier1 0..1 string Auxiliary State Identifier1 Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/AuxiliaryStateIdentifier1
    ..... auxiliaryStateIdentifier2 0..1 string Auxiliary State Identifier2 Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/AuxiliaryStateIdentifier2
    .... value 0..1 string Death Record Identifier (YYYYJJNNNNNN)
    Max Length: 12
    ... type 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
    Fixed Value: collection
    ... Slices for entry 0..* BackboneElement Entry in the bundle - will have a resource or information
    Slice: Unordered, Open by profile:resource
    .... entry:All Slices Content/Rules for all slices
    ..... resource 1..1 Resource A resource in the bundle
    .... entry:CodedRaceAndEthnicity 0..1 BackboneElement CodedRaceAndEthnicity
    ..... resource 0..1 ObservationCodedRaceAndEthnicityVitalRecords Measurements and simple assertions
    .... entry:InputRaceAndEthnicity 0..1 BackboneElement InputRaceAndEthnicity
    ..... resource 0..1 ObservationInputRaceAndEthnicityVitalRecords Measurements and simple assertions

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Bundle C 0..* Bundle Contains a collection of resources
    bdl-1: total only when a search or history
    bdl-2: entry.search only when a search
    bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
    bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
    bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
    bdl-9: A document must have an identifier with a system and a value
    bdl-10: A document must have a date
    bdl-11: A document must have a Composition as the first resource
    bdl-12: A message must have a MessageHeader as the first resource
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... identifier Σ 1..1 Identifier Persistent identifier for the bundle
    .... Slices for extension Content/Rules for all slices
    ..... certificateNumber 0..1 string Certificate Number
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CertificateNumber
    ..... auxiliaryStateIdentifier1 0..1 string Auxiliary State Identifier1 Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/AuxiliaryStateIdentifier1
    ..... auxiliaryStateIdentifier2 0..1 string Auxiliary State Identifier2 Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/AuxiliaryStateIdentifier2
    .... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

    .... value Σ 0..1 string Death Record Identifier (YYYYJJNNNNNN)
    Example General: 123456
    Max Length: 12
    ... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
    Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


    Fixed Value: collection
    .... entry:All Slices Content/Rules for all slices
    ..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ..... resource Σ 1..1 Resource A resource in the bundle
    .... entry:CodedRaceAndEthnicity ΣC 0..1 BackboneElement CodedRaceAndEthnicity
    bdl-5: must be a resource unless there's a request or response
    bdl-8: fullUrl cannot be a version specific reference
    This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
    ..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ..... resource 0..1 ObservationCodedRaceAndEthnicityVitalRecords Measurements and simple assertions
    .... entry:InputRaceAndEthnicity ΣC 0..1 BackboneElement InputRaceAndEthnicity
    bdl-5: must be a resource unless there's a request or response
    bdl-8: fullUrl cannot be a version specific reference
    This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
    ..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ..... resource 0..1 ObservationInputRaceAndEthnicityVitalRecords Measurements and simple assertions

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Bundle.identifier.userequiredIdentifierUse
    http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    from the FHIR Standard
    Bundle.typerequiredFixed Value: collection
    http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
    from the FHIR Standard
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Bundle C 0..* Bundle Contains a collection of resources
    bdl-1: total only when a search or history
    bdl-2: entry.search only when a search
    bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
    bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
    bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
    bdl-9: A document must have an identifier with a system and a value
    bdl-10: A document must have a date
    bdl-11: A document must have a Composition as the first resource
    bdl-12: A message must have a MessageHeader as the first resource
    ... id Σ 0..1 id Logical id of this artifact
    ... meta Σ 0..1 Meta Metadata about the resource
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... identifier Σ 1..1 Identifier Persistent identifier for the bundle
    .... id 0..1 string Unique id for inter-element referencing
    .... Slices for extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... certificateNumber 0..1 string Certificate Number
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CertificateNumber
    ..... auxiliaryStateIdentifier1 0..1 string Auxiliary State Identifier1 Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/AuxiliaryStateIdentifier1
    ..... auxiliaryStateIdentifier2 0..1 string Auxiliary State Identifier2 Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/AuxiliaryStateIdentifier2
    .... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

    .... type Σ 0..1 CodeableConcept Description of identifier
    Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

    .... system Σ 0..1 uri The namespace for the identifier value
    Example General: http://www.acme.com/identifiers/patient
    .... value Σ 0..1 string Death Record Identifier (YYYYJJNNNNNN)
    Example General: 123456
    Max Length: 12
    .... period Σ 0..1 Period Time period when id is/was valid for use
    .... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
    ... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
    Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


    Fixed Value: collection
    ... timestamp Σ 0..1 instant When the bundle was assembled
    ... total ΣC 0..1 unsignedInt If search, the total number of matches
    ... link Σ 0..* BackboneElement Links related to this Bundle
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    .... relation Σ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
    .... url Σ 1..1 uri Reference details for the link
    ... Slices for entry ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
    Slice: Unordered, Open by profile:resource
    bdl-5: must be a resource unless there's a request or response
    bdl-8: fullUrl cannot be a version specific reference
    This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
    .... entry:All Slices Content/Rules for all slices
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    ..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ..... link Σ 0..* See link (Bundle) Links related to this entry
    ..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
    ..... resource Σ 1..1 Resource A resource in the bundle
    ..... search ΣC 0..1 BackboneElement Search related information
    ...... id 0..1 string Unique id for inter-element referencing
    ...... extension 0..* Extension Additional content defined by implementations
    ...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ...... mode Σ 0..1 code match | include | outcome - why this is in the result set
    Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

    ...... score Σ 0..1 decimal Search ranking (between 0 and 1)
    ..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
    ...... id 0..1 string Unique id for inter-element referencing
    ...... extension 0..* Extension Additional content defined by implementations
    ...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
    Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

    ...... url Σ 1..1 uri URL for HTTP equivalent of this entry
    ...... ifNoneMatch Σ 0..1 string For managing cache currency
    ...... ifModifiedSince Σ 0..1 instant For managing cache currency
    ...... ifMatch Σ 0..1 string For managing update contention
    ...... ifNoneExist Σ 0..1 string For conditional creates
    ..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
    ...... id 0..1 string Unique id for inter-element referencing
    ...... extension 0..* Extension Additional content defined by implementations
    ...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ...... status Σ 1..1 string Status response code (text optional)
    ...... location Σ 0..1 uri The location (if the operation returns a location)
    ...... etag Σ 0..1 string The Etag for the resource (if relevant)
    ...... lastModified Σ 0..1 instant Server's date time modified
    ...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
    .... entry:CodedRaceAndEthnicity ΣC 0..1 BackboneElement CodedRaceAndEthnicity
    bdl-5: must be a resource unless there's a request or response
    bdl-8: fullUrl cannot be a version specific reference
    This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    ..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ..... link Σ 0..* See link (Bundle) Links related to this entry
    ..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
    ..... resource 0..1 ObservationCodedRaceAndEthnicityVitalRecords Measurements and simple assertions
    ..... search ΣC 0..1 BackboneElement Search related information
    ...... id 0..1 string Unique id for inter-element referencing
    ...... extension 0..* Extension Additional content defined by implementations
    ...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ...... mode Σ 0..1 code match | include | outcome - why this is in the result set
    Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

    ...... score Σ 0..1 decimal Search ranking (between 0 and 1)
    ..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
    ...... id 0..1 string Unique id for inter-element referencing
    ...... extension 0..* Extension Additional content defined by implementations
    ...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
    Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

    ...... url Σ 1..1 uri URL for HTTP equivalent of this entry
    ...... ifNoneMatch Σ 0..1 string For managing cache currency
    ...... ifModifiedSince Σ 0..1 instant For managing cache currency
    ...... ifMatch Σ 0..1 string For managing update contention
    ...... ifNoneExist Σ 0..1 string For conditional creates
    ..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
    ...... id 0..1 string Unique id for inter-element referencing
    ...... extension 0..* Extension Additional content defined by implementations
    ...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ...... status Σ 1..1 string Status response code (text optional)
    ...... location Σ 0..1 uri The location (if the operation returns a location)
    ...... etag Σ 0..1 string The Etag for the resource (if relevant)
    ...... lastModified Σ 0..1 instant Server's date time modified
    ...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
    .... entry:InputRaceAndEthnicity ΣC 0..1 BackboneElement InputRaceAndEthnicity
    bdl-5: must be a resource unless there's a request or response
    bdl-8: fullUrl cannot be a version specific reference
    This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    ..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ..... link Σ 0..* See link (Bundle) Links related to this entry
    ..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
    ..... resource 0..1 ObservationInputRaceAndEthnicityVitalRecords Measurements and simple assertions
    ..... search ΣC 0..1 BackboneElement Search related information
    ...... id 0..1 string Unique id for inter-element referencing
    ...... extension 0..* Extension Additional content defined by implementations
    ...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ...... mode Σ 0..1 code match | include | outcome - why this is in the result set
    Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

    ...... score Σ 0..1 decimal Search ranking (between 0 and 1)
    ..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
    ...... id 0..1 string Unique id for inter-element referencing
    ...... extension 0..* Extension Additional content defined by implementations
    ...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
    Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

    ...... url Σ 1..1 uri URL for HTTP equivalent of this entry
    ...... ifNoneMatch Σ 0..1 string For managing cache currency
    ...... ifModifiedSince Σ 0..1 instant For managing cache currency
    ...... ifMatch Σ 0..1 string For managing update contention
    ...... ifNoneExist Σ 0..1 string For conditional creates
    ..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
    ...... id 0..1 string Unique id for inter-element referencing
    ...... extension 0..* Extension Additional content defined by implementations
    ...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ...... status Σ 1..1 string Status response code (text optional)
    ...... location Σ 0..1 uri The location (if the operation returns a location)
    ...... etag Σ 0..1 string The Etag for the resource (if relevant)
    ...... lastModified Σ 0..1 instant Server's date time modified
    ...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
    ... signature Σ 0..1 Signature Digital Signature

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Bundle.languagepreferredCommonLanguages
    Additional Bindings Purpose
    AllLanguages Max Binding
    http://hl7.org/fhir/ValueSet/languages
    from the FHIR Standard
    Bundle.identifier.userequiredIdentifierUse
    http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    from the FHIR Standard
    Bundle.identifier.typeextensibleIdentifier Type Codes
    http://hl7.org/fhir/ValueSet/identifier-type
    from the FHIR Standard
    Bundle.typerequiredFixed Value: collection
    http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
    from the FHIR Standard
    Bundle.entry.search.moderequiredSearchEntryMode
    http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
    from the FHIR Standard
    Bundle.entry.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    from the FHIR Standard
    Bundle.entry:CodedRaceAndEthnicity.search.moderequiredSearchEntryMode
    http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
    from the FHIR Standard
    Bundle.entry:CodedRaceAndEthnicity.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    from the FHIR Standard
    Bundle.entry:InputRaceAndEthnicity.search.moderequiredSearchEntryMode
    http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
    from the FHIR Standard
    Bundle.entry:InputRaceAndEthnicity.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    from the FHIR Standard

    Differential View

    This structure is derived from Bundle

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Bundle 0..* Bundle Contains a collection of resources
    ... identifier 1..1 Identifier Persistent identifier for the bundle
    .... Slices for extension Content/Rules for all slices
    ..... certificateNumber 0..1 string Certificate Number
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CertificateNumber
    ..... auxiliaryStateIdentifier1 0..1 string Auxiliary State Identifier1 Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/AuxiliaryStateIdentifier1
    ..... auxiliaryStateIdentifier2 0..1 string Auxiliary State Identifier2 Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/AuxiliaryStateIdentifier2
    .... value 0..1 string Death Record Identifier (YYYYJJNNNNNN)
    Max Length: 12
    ... type 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
    Fixed Value: collection
    ... Slices for entry 0..* BackboneElement Entry in the bundle - will have a resource or information
    Slice: Unordered, Open by profile:resource
    .... entry:All Slices Content/Rules for all slices
    ..... resource 1..1 Resource A resource in the bundle
    .... entry:CodedRaceAndEthnicity 0..1 BackboneElement CodedRaceAndEthnicity
    ..... resource 0..1 ObservationCodedRaceAndEthnicityVitalRecords Measurements and simple assertions
    .... entry:InputRaceAndEthnicity 0..1 BackboneElement InputRaceAndEthnicity
    ..... resource 0..1 ObservationInputRaceAndEthnicityVitalRecords Measurements and simple assertions

    doco Documentation for this format

    Key Elements View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Bundle C 0..* Bundle Contains a collection of resources
    bdl-1: total only when a search or history
    bdl-2: entry.search only when a search
    bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
    bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
    bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
    bdl-9: A document must have an identifier with a system and a value
    bdl-10: A document must have a date
    bdl-11: A document must have a Composition as the first resource
    bdl-12: A message must have a MessageHeader as the first resource
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... identifier Σ 1..1 Identifier Persistent identifier for the bundle
    .... Slices for extension Content/Rules for all slices
    ..... certificateNumber 0..1 string Certificate Number
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CertificateNumber
    ..... auxiliaryStateIdentifier1 0..1 string Auxiliary State Identifier1 Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/AuxiliaryStateIdentifier1
    ..... auxiliaryStateIdentifier2 0..1 string Auxiliary State Identifier2 Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/AuxiliaryStateIdentifier2
    .... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

    .... value Σ 0..1 string Death Record Identifier (YYYYJJNNNNNN)
    Example General: 123456
    Max Length: 12
    ... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
    Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


    Fixed Value: collection
    .... entry:All Slices Content/Rules for all slices
    ..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ..... resource Σ 1..1 Resource A resource in the bundle
    .... entry:CodedRaceAndEthnicity ΣC 0..1 BackboneElement CodedRaceAndEthnicity
    bdl-5: must be a resource unless there's a request or response
    bdl-8: fullUrl cannot be a version specific reference
    This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
    ..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ..... resource 0..1 ObservationCodedRaceAndEthnicityVitalRecords Measurements and simple assertions
    .... entry:InputRaceAndEthnicity ΣC 0..1 BackboneElement InputRaceAndEthnicity
    bdl-5: must be a resource unless there's a request or response
    bdl-8: fullUrl cannot be a version specific reference
    This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
    ..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ..... resource 0..1 ObservationInputRaceAndEthnicityVitalRecords Measurements and simple assertions

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Bundle.identifier.userequiredIdentifierUse
    http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    from the FHIR Standard
    Bundle.typerequiredFixed Value: collection
    http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
    from the FHIR Standard

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Bundle C 0..* Bundle Contains a collection of resources
    bdl-1: total only when a search or history
    bdl-2: entry.search only when a search
    bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
    bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
    bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
    bdl-9: A document must have an identifier with a system and a value
    bdl-10: A document must have a date
    bdl-11: A document must have a Composition as the first resource
    bdl-12: A message must have a MessageHeader as the first resource
    ... id Σ 0..1 id Logical id of this artifact
    ... meta Σ 0..1 Meta Metadata about the resource
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... identifier Σ 1..1 Identifier Persistent identifier for the bundle
    .... id 0..1 string Unique id for inter-element referencing
    .... Slices for extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... certificateNumber 0..1 string Certificate Number
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CertificateNumber
    ..... auxiliaryStateIdentifier1 0..1 string Auxiliary State Identifier1 Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/AuxiliaryStateIdentifier1
    ..... auxiliaryStateIdentifier2 0..1 string Auxiliary State Identifier2 Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/AuxiliaryStateIdentifier2
    .... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

    .... type Σ 0..1 CodeableConcept Description of identifier
    Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

    .... system Σ 0..1 uri The namespace for the identifier value
    Example General: http://www.acme.com/identifiers/patient
    .... value Σ 0..1 string Death Record Identifier (YYYYJJNNNNNN)
    Example General: 123456
    Max Length: 12
    .... period Σ 0..1 Period Time period when id is/was valid for use
    .... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
    ... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
    Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


    Fixed Value: collection
    ... timestamp Σ 0..1 instant When the bundle was assembled
    ... total ΣC 0..1 unsignedInt If search, the total number of matches
    ... link Σ 0..* BackboneElement Links related to this Bundle
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    .... relation Σ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
    .... url Σ 1..1 uri Reference details for the link
    ... Slices for entry ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
    Slice: Unordered, Open by profile:resource
    bdl-5: must be a resource unless there's a request or response
    bdl-8: fullUrl cannot be a version specific reference
    This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
    .... entry:All Slices Content/Rules for all slices
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    ..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ..... link Σ 0..* See link (Bundle) Links related to this entry
    ..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
    ..... resource Σ 1..1 Resource A resource in the bundle
    ..... search ΣC 0..1 BackboneElement Search related information
    ...... id 0..1 string Unique id for inter-element referencing
    ...... extension 0..* Extension Additional content defined by implementations
    ...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ...... mode Σ 0..1 code match | include | outcome - why this is in the result set
    Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

    ...... score Σ 0..1 decimal Search ranking (between 0 and 1)
    ..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
    ...... id 0..1 string Unique id for inter-element referencing
    ...... extension 0..* Extension Additional content defined by implementations
    ...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
    Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

    ...... url Σ 1..1 uri URL for HTTP equivalent of this entry
    ...... ifNoneMatch Σ 0..1 string For managing cache currency
    ...... ifModifiedSince Σ 0..1 instant For managing cache currency
    ...... ifMatch Σ 0..1 string For managing update contention
    ...... ifNoneExist Σ 0..1 string For conditional creates
    ..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
    ...... id 0..1 string Unique id for inter-element referencing
    ...... extension 0..* Extension Additional content defined by implementations
    ...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ...... status Σ 1..1 string Status response code (text optional)
    ...... location Σ 0..1 uri The location (if the operation returns a location)
    ...... etag Σ 0..1 string The Etag for the resource (if relevant)
    ...... lastModified Σ 0..1 instant Server's date time modified
    ...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
    .... entry:CodedRaceAndEthnicity ΣC 0..1 BackboneElement CodedRaceAndEthnicity
    bdl-5: must be a resource unless there's a request or response
    bdl-8: fullUrl cannot be a version specific reference
    This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    ..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ..... link Σ 0..* See link (Bundle) Links related to this entry
    ..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
    ..... resource 0..1 ObservationCodedRaceAndEthnicityVitalRecords Measurements and simple assertions
    ..... search ΣC 0..1 BackboneElement Search related information
    ...... id 0..1 string Unique id for inter-element referencing
    ...... extension 0..* Extension Additional content defined by implementations
    ...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ...... mode Σ 0..1 code match | include | outcome - why this is in the result set
    Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

    ...... score Σ 0..1 decimal Search ranking (between 0 and 1)
    ..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
    ...... id 0..1 string Unique id for inter-element referencing
    ...... extension 0..* Extension Additional content defined by implementations
    ...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
    Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

    ...... url Σ 1..1 uri URL for HTTP equivalent of this entry
    ...... ifNoneMatch Σ 0..1 string For managing cache currency
    ...... ifModifiedSince Σ 0..1 instant For managing cache currency
    ...... ifMatch Σ 0..1 string For managing update contention
    ...... ifNoneExist Σ 0..1 string For conditional creates
    ..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
    ...... id 0..1 string Unique id for inter-element referencing
    ...... extension 0..* Extension Additional content defined by implementations
    ...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ...... status Σ 1..1 string Status response code (text optional)
    ...... location Σ 0..1 uri The location (if the operation returns a location)
    ...... etag Σ 0..1 string The Etag for the resource (if relevant)
    ...... lastModified Σ 0..1 instant Server's date time modified
    ...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
    .... entry:InputRaceAndEthnicity ΣC 0..1 BackboneElement InputRaceAndEthnicity
    bdl-5: must be a resource unless there's a request or response
    bdl-8: fullUrl cannot be a version specific reference
    This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    ..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ..... link Σ 0..* See link (Bundle) Links related to this entry
    ..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
    ..... resource 0..1 ObservationInputRaceAndEthnicityVitalRecords Measurements and simple assertions
    ..... search ΣC 0..1 BackboneElement Search related information
    ...... id 0..1 string Unique id for inter-element referencing
    ...... extension 0..* Extension Additional content defined by implementations
    ...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ...... mode Σ 0..1 code match | include | outcome - why this is in the result set
    Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

    ...... score Σ 0..1 decimal Search ranking (between 0 and 1)
    ..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
    ...... id 0..1 string Unique id for inter-element referencing
    ...... extension 0..* Extension Additional content defined by implementations
    ...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
    Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

    ...... url Σ 1..1 uri URL for HTTP equivalent of this entry
    ...... ifNoneMatch Σ 0..1 string For managing cache currency
    ...... ifModifiedSince Σ 0..1 instant For managing cache currency
    ...... ifMatch Σ 0..1 string For managing update contention
    ...... ifNoneExist Σ 0..1 string For conditional creates
    ..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
    ...... id 0..1 string Unique id for inter-element referencing
    ...... extension 0..* Extension Additional content defined by implementations
    ...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ...... status Σ 1..1 string Status response code (text optional)
    ...... location Σ 0..1 uri The location (if the operation returns a location)
    ...... etag Σ 0..1 string The Etag for the resource (if relevant)
    ...... lastModified Σ 0..1 instant Server's date time modified
    ...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
    ... signature Σ 0..1 Signature Digital Signature

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Bundle.languagepreferredCommonLanguages
    Additional Bindings Purpose
    AllLanguages Max Binding
    http://hl7.org/fhir/ValueSet/languages
    from the FHIR Standard
    Bundle.identifier.userequiredIdentifierUse
    http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    from the FHIR Standard
    Bundle.identifier.typeextensibleIdentifier Type Codes
    http://hl7.org/fhir/ValueSet/identifier-type
    from the FHIR Standard
    Bundle.typerequiredFixed Value: collection
    http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
    from the FHIR Standard
    Bundle.entry.search.moderequiredSearchEntryMode
    http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
    from the FHIR Standard
    Bundle.entry.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    from the FHIR Standard
    Bundle.entry:CodedRaceAndEthnicity.search.moderequiredSearchEntryMode
    http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
    from the FHIR Standard
    Bundle.entry:CodedRaceAndEthnicity.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    from the FHIR Standard
    Bundle.entry:InputRaceAndEthnicity.search.moderequiredSearchEntryMode
    http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
    from the FHIR Standard
    Bundle.entry:InputRaceAndEthnicity.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    from the FHIR Standard

     

    Other representations of profile: CSV, Excel, Schematron