International Birth And Child Model Implementation Guide
1.0.0-ballot - ballot
International Birth And Child Model Implementation Guide
1.0.0-ballot - ballot
International Birth And Child Model Implementation Guide, published by HL7 International - CHOICE Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0-ballot). This version is based on the current content of https://github.com/HL7/fetal_records/ and changes regularly. See the Directory of published versions
| 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Identifier
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Identifier | 0..* | Identifier | An identifier intended for computation | |
 type | S | 0..1 | CodeableConcept | Description of identifier Required Pattern: At least the following |
   coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
  system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PI | |
| system | S | 1..1 | uri | The namespace for the identifier value |
| value | S | 1..1 | string | The value that is unique |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | C | 0..* | Identifier | An identifier intended for computation |
 use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
 type | SΣ | 0..1 | CodeableConcept | Description 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 |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PI | |
| system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | SΣC | 1..1 | string | The value that is unique Example General: 123456 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Identifier.use | required | IdentifierUse |
| Identifier.type | extensible | Pattern: PI |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ident-1 | warning | Identifier | Identifier 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() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | C | 0..* | Identifier | An identifier intended for computation |
| id | 0..1 | id | Unique id for inter-element referencing | |
 extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | SΣ | 0..1 | CodeableConcept | Description 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 |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PI | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | SΣC | 1..1 | string | The value that is unique Example General: 123456 |
| 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) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Identifier.use | required | IdentifierUse |
| Identifier.type | extensible | Pattern: PI |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Identifier
Differential View
This structure is derived from Identifier
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | 0..* | Identifier | An identifier intended for computation | |
| type | S | 0..1 | CodeableConcept | Description of identifier Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PI | |
| system | S | 1..1 | uri | The namespace for the identifier value |
| value | S | 1..1 | string | The value that is unique |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | C | 0..* | Identifier | An identifier intended for computation |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | SΣ | 0..1 | CodeableConcept | Description 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 |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PI | |
| system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | SΣC | 1..1 | string | The value that is unique Example General: 123456 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Identifier.use | required | IdentifierUse |
| Identifier.type | extensible | Pattern: PI |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ident-1 | warning | Identifier | Identifier 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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | C | 0..* | Identifier | An identifier intended for computation |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | SΣ | 0..1 | CodeableConcept | Description 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 |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PI | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | SΣC | 1..1 | string | The value that is unique Example General: 123456 |
| 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) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Identifier.use | required | IdentifierUse |
| Identifier.type | extensible | Pattern: PI |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Identifier
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 International - CHOICE Work Group. Package hl7.fhir.uv.ibcm#1.0.0-ballot based on FHIR 5.0.0. Generated 2023-08-01
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change