International Birth And Child Model Implementation Guide
1.0.0-ballot - ballot International flag

This page is part of the International Birth And Child Model Implementation Guide (v1.0.0-ballot: Releases Ballot 1) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Data Type Profile: IBCM Fetus Identifier profile

Official URL: http://hl7.org/fhir/uv/ibcm/StructureDefinition/fetal-record-identifier Version: 1.0.0-ballot
Draft as of 2023-08-01 Computable Name: FetalIdentifier

DataType Profile to represent Identifier of a fetal record in context.

Usage:

  • This DataType Constraint 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 Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierAn identifier intended for computation
... type S0..1CodeableConceptDescription of identifier
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: PI
... system S1..1uriThe namespace for the identifier value
... value S1..1stringThe value that is unique

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C0..*IdentifierAn identifier intended for computation
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... type SΣ0..1CodeableConceptDescription of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: PI
... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Identifier.userequiredIdentifierUse
Identifier.typeextensiblePattern: PI

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ident-1warningIdentifierIdentifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
: value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C0..*IdentifierAn identifier intended for computation
... id 0..1idUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: PI
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
... value SΣC1..1stringThe value that is unique
Example General: 123456
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Identifier.userequiredIdentifierUse
Identifier.typeextensiblePattern: PI

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Identifier

Summary

Mandatory: 2 elements
Must-Support: 3 elements

Differential View

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierAn identifier intended for computation
... type S0..1CodeableConceptDescription of identifier
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: PI
... system S1..1uriThe namespace for the identifier value
... value S1..1stringThe value that is unique

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C0..*IdentifierAn identifier intended for computation
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... type SΣ0..1CodeableConceptDescription of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: PI
... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Identifier.userequiredIdentifierUse
Identifier.typeextensiblePattern: PI

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ident-1warningIdentifierIdentifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
: value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C0..*IdentifierAn identifier intended for computation
... id 0..1idUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: PI
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
... value SΣC1..1stringThe value that is unique
Example General: 123456
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Identifier.userequiredIdentifierUse
Identifier.typeextensiblePattern: PI

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Identifier

Summary

Mandatory: 2 elements
Must-Support: 3 elements

 

Other representations of profile: CSV, Excel, Schematron