Vital Records Common Profiles Library
0.1.0 - STU 1 Ballot
Vital Records Common Profiles Library
0.1.0 - STU 1 Ballot
This page is part of the Vital Records Common Profile Library (v0.1.0: STU 1 on FHIR R4 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions 
| Defining URL: | http://hl7.org/fhir/us/vr-common-library/StructureDefinition/RelatedPerson-father-natural |
| Version: | 0.1.0 |
| Name: | RelatedPersonFatherNatural |
| Title: | RelatedPerson - Father Natural |
| Status: | Active as of 2020-12-16T17:44:45+00:00 |
| Definition: | The biological (natural) father of the newborn or fetus. |
| Publisher: | HL7 International - Public Health Work Group |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/vr-common-library/StructureDefinition/RelatedPerson-father-natural
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from RelatedPersonFather
This structure is derived from RelatedPersonFather
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  RelatedPerson | 0..* | RelatedPersonFather | The biological father of the newborn or fetus. | |
  relationship | 1..1 | CodeableConcept | natural father 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/v3-RoleCode | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NFTH | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | 0..* | RelatedPersonFather | The biological father of the newborn or fetus. | |
 id | Σ | 0..1 | string | 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 |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 Extension-relatedperson-deceased | S | 0..1 | boolean, dateTime | Extension URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-deceased |
| Extension-relatedperson-birthplace | S | 0..1 | Address | Extension URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-birthplace |
| Extension-relatedperson-race | S | 0..1 | (Complex) | RelatedPerson Race Extension URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-race |
| Extension-relatedperson-ethnicity | S | 0..1 | (Complex) | RelatedPerson ethnicity Extension URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-ethnicity |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 0..* | Identifier | A human identifier for this person |
| active | ?!Σ | 0..1 | boolean | Whether this related person's record is in active use |
 patient | Σ | 1..1 | Reference(Patient - Child | Patient - Decedent Fetus) | The patient this person is related to |
 relationship | SΣ | 1..1 | CodeableConcept | natural father Binding: Father Relationship (required) 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/v3-RoleCode | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NFTH | |
| 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 | |
| name | SΣ | 1..* | HumanName | A name associated with the person |
| telecom | SΣ | 0..* | ContactPoint | A contact detail for the person |
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
| birthDate | SΣ | 0..1 | date | The date on which the related person was born |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Extension-date-part-absent-reason | S | 0..* | (Complex) | Indicates reason for missing birthDate data. URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-date-part-absent-reason |
| value | 0..1 | date | Primitive value for date | |
| address | SΣ | 0..* | Address | Address where the related person can be contacted or visited |
| photo | 0..* | Attachment | Image of the person | |
| period | 0..1 | Period | Period of time that this relationship is considered valid | |
| communication | 0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |
| 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 |
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| preferred | 0..1 | boolean | Language preference indicator | |
| Documentation for this format | ||||
This structure is derived from RelatedPersonFather
Differential View
This structure is derived from RelatedPersonFather
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | 0..* | RelatedPersonFather | The biological father of the newborn or fetus. | |
| relationship | 1..1 | CodeableConcept | natural father 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/v3-RoleCode | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NFTH | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | 0..* | RelatedPersonFather | The biological father of the newborn or fetus. | |
| id | Σ | 0..1 | string | 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 |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Extension-relatedperson-deceased | S | 0..1 | boolean, dateTime | Extension URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-deceased |
| Extension-relatedperson-birthplace | S | 0..1 | Address | Extension URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-birthplace |
| Extension-relatedperson-race | S | 0..1 | (Complex) | RelatedPerson Race Extension URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-race |
| Extension-relatedperson-ethnicity | S | 0..1 | (Complex) | RelatedPerson ethnicity Extension URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-relatedperson-ethnicity |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 0..* | Identifier | A human identifier for this person |
| active | ?!Σ | 0..1 | boolean | Whether this related person's record is in active use |
| patient | Σ | 1..1 | Reference(Patient - Child | Patient - Decedent Fetus) | The patient this person is related to |
| relationship | SΣ | 1..1 | CodeableConcept | natural father Binding: Father Relationship (required) 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/v3-RoleCode | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NFTH | |
| 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 | |
| name | SΣ | 1..* | HumanName | A name associated with the person |
| telecom | SΣ | 0..* | ContactPoint | A contact detail for the person |
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
| birthDate | SΣ | 0..1 | date | The date on which the related person was born |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Extension-date-part-absent-reason | S | 0..* | (Complex) | Indicates reason for missing birthDate data. URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-date-part-absent-reason |
| value | 0..1 | date | Primitive value for date | |
| address | SΣ | 0..* | Address | Address where the related person can be contacted or visited |
| photo | 0..* | Attachment | Image of the person | |
| period | 0..1 | Period | Period of time that this relationship is considered valid | |
| communication | 0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |
| 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 |
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| preferred | 0..1 | boolean | Language preference indicator | |
| Documentation for this format | ||||
Other representations of profile: Schematron
| Path | Conformance | ValueSet / Code |
| RelatedPerson.language | preferred | CommonLanguages Max Binding: AllLanguages |
| RelatedPerson.relationship | required | Pattern: NFTH |
| RelatedPerson.gender | required | AdministrativeGender |
| RelatedPerson.communication.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Id | Path | Details | Requirements |
| dom-2 | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | RelatedPerson | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | RelatedPerson | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | RelatedPerson.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | RelatedPerson.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | RelatedPerson.extension:deceased | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | RelatedPerson.extension:deceased | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | RelatedPerson.extension:birthPlace | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | RelatedPerson.extension:birthPlace | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | RelatedPerson.extension:race | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | RelatedPerson.extension:race | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | RelatedPerson.extension:ethnicity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | RelatedPerson.extension:ethnicity | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | RelatedPerson.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | RelatedPerson.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | RelatedPerson.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.active | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.patient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.relationship | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.gender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.birthDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.birthDate.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | RelatedPerson.birthDate.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | RelatedPerson.birthDate.extension:datePartAbsentReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | RelatedPerson.birthDate.extension:datePartAbsentReason | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | RelatedPerson.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.photo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.communication | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.communication.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | RelatedPerson.communication.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | RelatedPerson.communication.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | RelatedPerson.communication.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | RelatedPerson.communication.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.communication.preferred | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2020+ HL7 International - Public Health Work Group. Package hl7.fhir.us.vr-common-library#0.1.0 based on FHIR 4.0.1. Generated 2020-12-16
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change