Patient


Estrutura FHIR para troca de informações demográficas sobre o membro nas bases da Sami.

OBS: As informações são compartilhadas apenas perante o consentimento prévio do membro.


Snapshot

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
mothersNameI0..1Extension(string)
GeolocationI0..1Extension(Complex)
id0..1string
id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueCodeableConceptCodeableConcept
url1..1uriFixed Value
PatientImmigrationI0..*Extension(Complex)Binding
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueBase64Binarybase64Binary
valueBooleanboolean
valueCanonicalcanonical()
valueCodecode
valueDatedate
valueDateTimedateTime
valueDecimaldecimal
valueIdid
valueInstantinstant
valueIntegerinteger
valueMarkdownmarkdown
valueOidoid
valuePositiveIntpositiveInt
valueStringstring
valueTimetime
valueUnsignedIntunsignedInt
valueUriuri
valueUrlurl
valueUuiduuid
valueAddressAddress
valueAgeAge
valueAnnotationAnnotation
valueAttachmentAttachment
valueCodeableConceptCodeableConcept
valueCodingCoding
valueContactPointContactPoint
valueCountCount
valueDistanceDistance
valueDurationDuration
valueHumanNameHumanName
valueIdentifierIdentifier
valueMoneyMoney
valuePeriodPeriod
valueQuantityQuantity
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueSignatureSignature
valueTimingTiming
valueContactDetailContactDetail
valueContributorContributor
valueDataRequirementDataRequirement
valueExpressionExpression
valueParameterDefinitionParameterDefinition
valueRelatedArtifactRelatedArtifact
valueTriggerDefinitionTriggerDefinition
valueUsageContextUsageContext
valueDosageDosage
valueMetaMeta
valueReferenceReference()
id0..1string
extensionI0..0Extension
url1..1uriFixed Value
id0..1string
extensionI0..*Extension
useΣ ?!0..0codeBinding
typeΣ0..0codeBinding
textΣ0..0string
lineΣ0..0string
cityΣ0..1string
districtΣ0..0string
stateΣ0..1string
postalCodeΣ0..0string
countryΣ0..0string
periodΣ I0..0Period
id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueDateTimedateTime
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueDateTimedateTime
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueBase64Binarybase64Binary
valueBooleanboolean
valueCanonicalcanonical()
valueCodecode
valueDatedate
valueDateTimedateTime
valueDecimaldecimal
valueIdid
valueInstantinstant
valueIntegerinteger
valueMarkdownmarkdown
valueOidoid
valuePositiveIntpositiveInt
valueStringstring
valueTimetime
valueUnsignedIntunsignedInt
valueUriuri
valueUrlurl
valueUuiduuid
valueAddressAddress
valueAgeAge
valueAnnotationAnnotation
valueAttachmentAttachment
valueCodeableConceptCodeableConcept
valueCodingCoding
valueContactPointContactPoint
valueCountCount
valueDistanceDistance
valueDurationDuration
valueHumanNameHumanName
valueIdentifierIdentifier
valueMoneyMoney
valuePeriodPeriod
valueQuantityQuantity
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueSignatureSignature
valueTimingTiming
valueContactDetailContactDetail
valueContributorContributor
valueDataRequirementDataRequirement
valueExpressionExpression
valueParameterDefinitionParameterDefinition
valueRelatedArtifactRelatedArtifact
valueTriggerDefinitionTriggerDefinition
valueUsageContextUsageContext
valueDosageDosage
valueMetaMeta
valueReferenceReference()
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
id0..1string
extensionI0..*Extension
coding
valueBase64Binarybase64Binary
valueBooleanboolean
valueCanonicalcanonical()
valueCodecode
valueDatedate
valueDateTimedateTime
valueDecimaldecimal
valueIdid
valueInstantinstant
valueIntegerinteger
valueMarkdownmarkdown
valueOidoid
valuePositiveIntpositiveInt
valueStringstring
valueTimetime
valueUnsignedIntunsignedInt
valueUriuri
valueUrlurl
valueUuiduuid
valueAddressAddress
valueAgeAge
valueAnnotationAnnotation
valueAttachmentAttachment
valueCodeableConceptCodeableConcept
valueCodingCoding
valueContactPointContactPoint
valueCountCount
valueDistanceDistance
valueDurationDuration
valueHumanNameHumanName
valueIdentifierIdentifier
valueMoneyMoney
valuePeriodPeriod
valueQuantityQuantity
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueSignatureSignature
valueTimingTiming
valueContactDetailContactDetail
valueContributorContributor
valueDataRequirementDataRequirement
valueExpressionExpression
valueParameterDefinitionParameterDefinition
valueRelatedArtifactRelatedArtifact
valueTriggerDefinitionTriggerDefinition
valueUsageContextUsageContext
valueDosageDosage
valueMetaMeta
valueReferenceReference()
modifierExtension?! I0..*Extension
id0..1string
extensionI0..*Extension
useΣ ?!1..1codeBinding
typeΣ0..0CodeableConceptBinding
systemΣ0..0uri
valueΣ0..0string
periodΣ I0..0Period
assignerΣ I0..0Reference(Organization)
activeΣ ?!0..1boolean
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
textΣ0..1string
familyΣ0..0string
givenΣ0..0string
prefixΣ0..0string
suffixΣ0..0string
periodΣ I0..0Period
id0..1string
extensionI0..*Extension
systemΣ I0..1codeBinding
valueΣ0..1string
useΣ ?!0..1codeBinding
rankΣ0..0positiveInt
periodΣ I0..0Period
genderΣ0..0codeBinding
birthDateΣ0..0date
id0..1string
extensionI0..*Extension
useΣ ?!0..0codeBinding
typeΣ0..0codeBinding
textΣ0..0string
lineΣ0..1string
cityΣ0..1string
districtΣ0..1string
stateΣ0..1string
postalCodeΣ0..1string
countryΣ0..1string
periodΣ I0..0Period
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..0string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..0boolean
textΣ0..0string
photoI0..0Attachment
generalPractitionerI0..0Reference(Organization | Practitioner | PractitionerRole)
managingOrganizationΣ I0..0Reference(Organization)


Patient..
Patient.extension0..
Patient.extensionExtension0..1
Patient.extensionExtension0..1
Patient.extensionExtension0..
Patient.extension.extension0..
Patient.extension.extension0..
Patient.extension.extension0..0
Patient.extensionExtension0..
Patient.extensionExtension0..1
Patient.extension.value[x]..
Patient.extensionExtension0..
Patient.extension.value[x]..
Patient.extension.value[x].use..0
Patient.extension.value[x].type..0
Patient.extension.value[x].text..0
Patient.extension.value[x].line..0
Patient.extension.value[x].city..
Patient.extension.value[x].district..0
Patient.extension.value[x].state..
Patient.extension.value[x].postalCode..0
Patient.extension.value[x].country..0
Patient.extension.value[x].period..0
Patient.extensionExtension0..1
Patient.extension.value[x]..
Patient.extensionExtension0..
Patient.extension.value[x]..
Patient.extensionExtension0..1
Patient.extension.value[x]..
Patient.extensionExtension0..1
Patient.extension.value[x]..
Patient.extension.value[x].coding..
Patient.identifier1..1
Patient.identifier.use1..
Patient.identifier.type..0
Patient.identifier.system..0
Patient.identifier.value..0
Patient.identifier.period..0
Patient.identifier.assigner..0
Patient.active..
Patient.name..1
Patient.name.use..
Patient.name.text..
Patient.name.family..0
Patient.name.given..0
Patient.name.prefix..0
Patient.name.suffix..0
Patient.name.period..0
Patient.telecom..
Patient.telecom.system..
Patient.telecom.value..
Patient.telecom.use..
Patient.telecom.rank..0
Patient.telecom.period..0
Patient.gender..0
Patient.birthDate..0
Patient.deceased[x]..0
Patient.address..1
Patient.address.use..0
Patient.address.type..0
Patient.address.text..0
Patient.address.line..1
Patient.address.city..
Patient.address.district..
Patient.address.state..
Patient.address.postalCode..
Patient.address.country..
Patient.address.period..0
Patient.maritalStatus..
Patient.maritalStatus.coding..1
Patient.maritalStatus.coding.system..
Patient.maritalStatus.coding.version..0
Patient.maritalStatus.coding.code..
Patient.maritalStatus.coding.display..
Patient.maritalStatus.coding.userSelected..0
Patient.maritalStatus.text..0
Patient.multipleBirth[x]..0
Patient.photo..0
Patient.contact..0
Patient.communication..0
Patient.generalPractitioner..0
Patient.managingOrganization..0
Patient.link..0


Patient
DefinitionDados populacionais, demográficos e outras informações administrativas sobre um indivíduo recebendo cuidados ou outros serviços relacionados à saúde.
Cardinality0...*
AliasSubjectOfCare Client Resident
Comments

Informações sobre um indivíduo que recebe serviços de saúde.

Invariants
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-4: 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-3: 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-6: A resource should have narrative for robust management
    text.`div`.exists()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
Mappings
  • rim: Entity. Role, or Act
  • rim: Patient[classCode=PAT]
  • cda: ClinicalDocument.recordTarget.patientRole
Patient.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality0...1
Typestring
SummaryTrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Patient.meta
DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality0...1
TypeMeta
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Patient.implicitRules
DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Patient.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

A human language.

CommonLanguages (preferred)
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Patient.text
DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality0...1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
Patient.contained
DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality0...*
TypeResource
Aliasinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
Patient.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:mothersName
DefinitionMother's maiden (unmarried) name, commonly collected to help verify patient identity.
Cardinality0...1
TypeExtension(string)
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
  • v2: PID-6
  • rim: Role relationship to entity with maiden name (?)
Patient.extension:Geolocation
DefinitionThe absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
Cardinality0...1
TypeExtension(Complex)
Aliasextensions, user content
Comments

The extension can be further extended to include unique geolocation identifiers, confidence, altitude, etc.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:PatientNationality
DefinitionThe nationality of the patient.
Cardinality0...*
TypeExtension(Complex)
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:PatientNationality.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Patient.extension:PatientNationality.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:PatientNationality.extension:code
DefinitionCode representing nationality of patient.
Cardinality0...1
TypeExtension
Binding

Nacionalidade de um indivíduo.

nationality (required)
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:PatientNationality.extension:code.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Patient.extension:PatientNationality.extension:code.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...0
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:PatientNationality.extension:code.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value

code

Mappings
  • rim: N/A
Patient.extension:PatientNationality.extension:code.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality1...1
TypeCodeableConcept
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:PatientNationality.extension:period
DefinitionPeriod when nationality was effective.
Cardinality0...0
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:PatientNationality.extension:period.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Patient.extension:PatientNationality.extension:period.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...0
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:PatientNationality.extension:period.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value

period

Mappings
  • rim: N/A
Patient.extension:PatientNationality.extension:period.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality1...1
TypePeriod
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:PatientNationality.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value

http://hl7.org/fhir/StructureDefinition/patient-nationality

Mappings
  • rim: N/A
Patient.extension:PatientNationality.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality0...0
Typebase64Binary
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:PatientImmigration
DefinitionThe patient's legal status as citizen of a country.
Cardinality0...*
TypeExtension(Complex)
Bindingnationality (extensible)
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:PatientScholarity
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...1
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:PatientScholarity.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Patient.extension:PatientScholarity.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:PatientScholarity.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value

https://www.samisaude.com.br/fhir/r4/CodeSystem/human-scholarity

Mappings
  • rim: N/A
Patient.extension:PatientScholarity.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality0...1
Typebase64Binary
Bindinghuman-scholarity (required)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:PatientBirthPlace
DefinitionThe registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements.
Cardinality0...1
TypeExtension(Address)
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:PatientBirthPlace.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Patient.extension:PatientBirthPlace.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...0
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:PatientBirthPlace.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value

http://hl7.org/fhir/StructureDefinition/patient-birthPlace

Mappings
  • rim: N/A
Patient.extension:PatientBirthPlace.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality1...1
TypeAddress
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:PatientBirthPlace.value[x].id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Patient.extension:PatientBirthPlace.value[x].extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:PatientBirthPlace.value[x].use
DefinitionThe purpose of this address.
Cardinality0...0
Typecode
Binding

The use of an address.

AddressUse (required)
ModifierTrue
SummaryTrue
Requirements

Allows an appropriate address to be chosen from a list of many.

Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

home


Mappings
  • rim: n/a
  • v2: XAD.7
  • rim: unique(./use)
  • servd: ./AddressPurpose
Patient.extension:PatientBirthPlace.value[x].type
DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
Cardinality0...0
Typecode
Binding

The type of an address (physical / postal).

AddressType (required)
SummaryTrue
Comments

The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

both


Mappings
  • rim: n/a
  • v2: XAD.18
  • rim: unique(./use)
  • vcard: address type parameter
Patient.extension:PatientBirthPlace.value[x].text
DefinitionSpecifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.
Cardinality0...0
Typestring
SummaryTrue
Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

137 Nowhere Street, Erewhon 9132


Mappings
  • rim: n/a
  • v2: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
  • rim: ./formatted
  • vcard: address label parameter
Patient.extension:PatientBirthPlace.value[x].line
DefinitionEste componente contém o número da casa, número do apartamento, nome da rua, direção e ponto da rua, Número da caixa postal, dicas de entrega e informações de endereço semelhantes.
Cardinality0...0
Typestring
SummaryTrue
Comments

Observe que as strings FHIR NÃO DEVEM exceder 1 MB de tamanho.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

137 Nowhere Street


Mappings
  • rim: n/a
  • v2: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
  • rim: AD.part[parttype = AL]
  • vcard: street
  • servd: ./StreetAddress (newline delimitted)
Patient.extension:PatientBirthPlace.value[x].city
DefinitionO nome da cidade, vila, subúrbio, vila ou outra comunidade ou centro de entrega.
Cardinality0...1
Typestring
SummaryTrue
AliasMunicpality
Comments

Observe que as strings FHIR NÃO DEVEM exceder 1 MB de tamanho.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

Erewhon


Mappings
  • rim: n/a
  • v2: XAD.3
  • rim: AD.part[parttype = CTY]
  • vcard: locality
  • servd: ./Jurisdiction
Patient.extension:PatientBirthPlace.value[x].district
DefinitionThe name of the administrative area (county).
Cardinality0...0
Typestring
SummaryTrue
AliasCounty
Comments

District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

Madison


Mappings
  • rim: n/a
  • v2: XAD.9
  • rim: AD.part[parttype = CNT | CPA]
Patient.extension:PatientBirthPlace.value[x].state
DefinitionSubunidade de um país com soberania limitada em um país organizado federalmente. Um código pode ser usado se houver códigos de uso comum (por exemplo, códigos de estado de 2 letras dos EUA). Utilizado estado no Brasil (Ex: SP/RJ)
Cardinality0...1
Typestring
SummaryTrue
AliasProvince, Territory
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XAD.4
  • rim: AD.part[parttype = STA]
  • vcard: region
  • servd: ./Region
Patient.extension:PatientBirthPlace.value[x].postalCode
DefinitionA postal code designating a region defined by the postal service.
Cardinality0...0
Typestring
SummaryTrue
AliasZip
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

9132


Mappings
  • rim: n/a
  • v2: XAD.5
  • rim: AD.part[parttype = ZIP]
  • vcard: code
  • servd: ./PostalIdentificationCode
Patient.extension:PatientBirthPlace.value[x].country
DefinitionCountry - a nation as commonly understood or generally accepted.
Cardinality0...0
Typestring
SummaryTrue
Comments

ISO 3166 3 letter codes can be used in place of a human readable country name.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XAD.6
  • rim: AD.part[parttype = CNT]
  • vcard: country
  • servd: ./Country
Patient.extension:PatientBirthPlace.value[x].period
DefinitionTime period when address was/is in use.
Cardinality0...0
TypePeriod
SummaryTrue
Requirements

Allows addresses to be placed in historical context.

Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Examples
General

{
  "start": "2010-03-23",
  "end": "2010-07-01"
}


Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2: XAD.12 / XAD.13 + XAD.14
  • rim: ./usablePeriod[type="IVL<TS>"]
  • servd: ./StartDate and ./EndDate
Patient.extension:PatientBirthTime
DefinitionThe time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively.
Cardinality0...1
TypeExtension(dateTime)
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:PatientBirthTime.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Patient.extension:PatientBirthTime.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...0
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:PatientBirthTime.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value

http://hl7.org/fhir/StructureDefinition/patient-birthTime

Mappings
  • rim: N/A
Patient.extension:PatientBirthTime.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality1...1
TypedateTime
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:PatientDeathTime
DefinitionOptional Extension Element - found in all resources.
Cardinality0...1
TypeExtension(dateTime)
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:PatientDeathTime.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Patient.extension:PatientDeathTime.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:PatientDeathTime.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value

https://www.samisaude.com.br/fhir/r4/StructureDefinition/patient-deathTime

Mappings
  • rim: N/A
Patient.extension:PatientDeathTime.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality0...1
TypedateTime
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:HumanRace
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...1
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:HumanRace.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Patient.extension:HumanRace.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:HumanRace.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value

https://www.samisaude.com.br/fhir/r4/CodeSystem/human-race

Mappings
  • rim: N/A
Patient.extension:HumanRace.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality0...1
Typebase64Binary
Bindinghuman-race (required)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:HumanGender
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...1
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:HumanGender.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Patient.extension:HumanGender.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:HumanGender.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value

https://www.samisaude.com.br/fhir/r4/CodeSystem/human-gender

Mappings
  • rim: N/A
Patient.extension:HumanGender.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality0...1
Typebase64Binary
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:HumanGender.value[x].id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Patient.extension:HumanGender.value[x].extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.extension:HumanGender.value[x].coding
DefinitionUma referência a um código definido por um sistema de terminologia.
Requirements

Permite codificações alternativas dentro de um sistema de código e traduções para outros sistemas de código.

Comments

Os códigos podem ser definidos casualmente em enumerações, ou listas de códigos, até definições muito formais, como SNOMED CT - consulte os Princípios Básicos do HL7 v3 para obter mais informações. A ordem das codificações é indefinida e NÃO DEVE ser usada para inferir significado. Geralmente, no máximo apenas um dos valores de codificação será rotulado como UserSelected = true.

Patient.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
Aliasextensions, user content
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.identifier
DefinitionIdentificador único do paciente.
Cardinality1...1
TypeIdentifier
SummaryTrue
Requirements

Os pacientes quase sempre recebem identificadores numéricos específicos.

Comments

Identificador do paciente, pode ser o número da carteirinha Sami, o cartão nacional de saúde, CPF ou RG

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • w5: FiveWs.identifier
  • v2: PID-3
  • rim: id
  • cda: .id
Patient.identifier.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Patient.identifier.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.identifier.use
DefinitionO propósito deste é o identificador único.
Cardinality1...1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)
ModifierTrue
SummaryTrue
Requirements

Permite que o identificador apropriado para um determinado contexto de uso seja selecionado entre um conjunto de identificadores.

Comments

Os aplicativos podem presumir que um identificador é permanente, a menos que diga explicitamente que é temporário.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Role.code or implied by context
Patient.identifier.type
DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality0...0
TypeCodeableConcept
Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Identifier Type Codes (extensible)
SummaryTrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: CX.5
  • rim: Role.code or implied by context
Patient.identifier.system
DefinitionEstabelece o namespace para o valor - ou seja, uma URL que descreve um conjunto de valores que são exclusivos.
Cardinality0...0
Typeuri
SummaryTrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

http://www.acme.com/identifiers/patient


Mappings
  • rim: n/a
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Patient.identifier.value
DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality0...0
Typestring
SummaryTrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

123456


Mappings
  • rim: n/a
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Patient.identifier.period
DefinitionTime period during which identifier is/was valid for use.
Cardinality0...0
TypePeriod
SummaryTrue
Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
Patient.identifier.assigner
DefinitionOrganization that issued/manages the identifier.
Cardinality0...0
TypeReference(Organization)
SummaryTrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
Patient.active
DefinitionSe este registro do paciente está em uso ativo. Muitos sistemas usam essa propriedade para marcar como pacientes não atuais, como aqueles que não foram vistos por um período de tempo com base nas regras de negócios de uma organização. É frequentemente usado para filtrar listas de pacientes para excluir pacientes inativos Pacientes falecidos também podem ser marcados como inativos pelos mesmos motivos, mas podem permanecer ativos por algum tempo após a morte.
Cardinality0...1
Typeboolean
ModifierTrue
SummaryTrue
Requirements

Precisa ser capaz de marcar um registro de paciente como não para ser usado porque foi criado por engano.

Comments

Se um registro estiver inativo e vinculado a um registro ativo, as atualizações futuras do paciente / registro devem ocorrer no outro paciente.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.status
  • rim: statusCode
  • cda: n/a
Patient.name
DefinitionNome do indivíduo.
Cardinality0...1
TypeHumanName
SummaryTrue
Requirements

Precisa ser capaz de rastrear o paciente por vários nomes. Exemplos são: seu civil ou seu nome social.

Comments

Um paciente/indivíduo pode ter vários nomes com diferentes usos ou períodos aplicáveis.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XPN
  • rim: EN (actually, PN)
  • servd: ProviderName
  • v2: PID-5, PID-9
  • rim: name
  • cda: .patient.name
Patient.name.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Patient.name.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.name.use
DefinitionIdentifica a finalidade do nome.
Cardinality0...1
Typecode
Binding

O uso de um nome humano.

NameUse (required)
ModifierTrue
SummaryTrue
Requirements

Permite que o nome apropriado para um determinado contexto de uso seja selecionado entre um conjunto de nomes.

Comments

Os aplicativos podem assumir que um nome é atual, a menos que diga explicitamente que é temporário ou antigo.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XPN.7, but often indicated by which field contains the name
  • rim: unique(./use)
  • servd: ./NamePurpose
Patient.name.text
DefinitionEspecifica o nome completo como deve ser exibido, por exemplo, em uma UI do aplicativo. Isso pode ser fornecido em vez de ou junto com as peças específicas.
Cardinality0...1
Typestring
SummaryTrue
Requirements

Um formulário não codificado e passível de renderização.

Comments

Pode fornecer uma representação de texto e partes. Os aplicativos que atualizam um nome DEVEM garantir que, quando o texto e as partes estiverem presentes, nenhum conteúdo seja incluído no texto que não seja encontrado em uma parte.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: implied by XPN.11
  • rim: ./formatted
Patient.name.family
DefinitionThe part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.
Cardinality0...0
Typestring
SummaryTrue
Aliassurname
Comments

Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XPN.1/FN.1
  • rim: ./part[partType = FAM]
  • servd: ./FamilyName
Patient.name.given
DefinitionNome dado.
Cardinality0...0
Typestring
SummaryTrue
Aliasfirst name, middle name
Comments

Se apenas as iniciais forem registradas, elas podem ser usadas no lugar das partes do nome completo. As iniciais podem ser separadas em vários nomes, mas geralmente não são devido a limitações paráticas. Este elemento não é chamado de "primeiro nome", pois os nomes dados nem sempre vêm em primeiro lugar.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XPN.2 + XPN.3
  • rim: ./part[partType = GIV]
  • servd: ./GivenNames
Patient.name.prefix
DefinitionPart of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.
Cardinality0...0
Typestring
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XPN.5
  • rim: ./part[partType = PFX]
  • servd: ./TitleCode
Patient.name.suffix
DefinitionPart of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
Cardinality0...0
Typestring
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XPN/4
  • rim: ./part[partType = SFX]
Patient.name.period
DefinitionIndicates the period of time when this name was valid for the named person.
Cardinality0...0
TypePeriod
SummaryTrue
Requirements

Allows names to be placed in historical context.

Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2: XPN.13 + XPN.14
  • rim: ./usablePeriod[type="IVL<TS>"]
  • servd: ./StartDate and ./EndDate
Patient.telecom
DefinitionDetalhes de contato (por exemplo, um número de telefone ou um endereço de e-mail) pelo qual o indivíduo pode ser contatado.
Cardinality0...*
TypeContactPoint
SummaryTrue
Requirements

As pessoas têm maneiras (principais) de contatá-las de alguma forma, como telefone, e-mail.

Comments

Um paciente pode ter várias maneiras de ser contatado com diferentes usos ou períodos aplicáveis. Pode ser necessário ter opções para entrar em contato com a pessoa com urgência e também para ajudar na identificação. O endereço pode não ir diretamente para o indivíduo, mas pode chegar a outra parte que pode representar o paciente (por exemplo, telefone residencial ou telefone comercial).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cpt-2: A system is required if a value is provided.
    value.empty() or system.exists()
Mappings
  • rim: n/a
  • v2: XTN
  • rim: TEL
  • servd: ContactPoint
  • v2: PID-13, PID-14, PID-40
  • rim: telecom
  • cda: .telecom
Patient.telecom.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Patient.telecom.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.telecom.system
DefinitionFormulário de telecomunicações para ponto de contato - qual sistema de comunicação é necessário para fazer uso do contato.
Cardinality0...1
Typecode
Binding

Telecommunications form for contact point.

ContactPointSystem (required)
SummaryTrue
Comments

Observe que as strings FHIR NÃO DEVEM exceder 1 MB de tamanho.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XTN.3
  • rim: ./scheme
  • servd: ./ContactPointType
Patient.telecom.value
DefinitionOs detalhes atuais do ponto de contato, em uma forma que seja significativa para o sistema de comunicação designado (ou seja, número de telefone ou endereço de e-mail).
Cardinality0...1
Typestring
SummaryTrue
Requirements

Precisa oferecer suporte a números legados que não estão em um formato rigidamente controlado.

Comments

Dados de texto adicionais, como números de ramais de telefone ou notas sobre o uso do contato, às vezes são incluídos no valor.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XTN.1 (or XTN.12)
  • rim: ./url
  • servd: ./Value
Patient.telecom.use
DefinitionIdentifica a finalidade do ponto de contato.
Cardinality0...1
Typecode
Binding

Use of contact point.

ContactPointUse (required)
ModifierTrue
SummaryTrue
Requirements

Precisa rastrear a maneira como uma pessoa usa esse contato, para que o usuário possa escolher qual é apropriado para sua finalidade.

Comments

Os aplicativos podem presumir que um contato é atual, a menos que diga explicitamente que é temporário ou antigo.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XTN.2 - but often indicated by field
  • rim: unique(./use)
  • servd: ./ContactPointPurpose
Patient.telecom.rank
DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Cardinality0...0
TypepositiveInt
SummaryTrue
Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: n/a
Patient.telecom.period
DefinitionTime period when the contact point was/is in use.
Cardinality0...0
TypePeriod
SummaryTrue
Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2: N/A
  • rim: ./usablePeriod[type="IVL<TS>"]
  • servd: ./StartDate and ./EndDate
Patient.gender
DefinitionAdministrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
Cardinality0...0
Typecode
Binding

The gender of a person used for administrative purposes.

AdministrativeGender (required)
SummaryTrue
Requirements

Needed for identification of the individual, in combination with (at least) name and birth date.

Comments

The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: PID-8
  • rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
  • cda: .patient.administrativeGenderCode
Patient.birthDate
DefinitionThe date of birth for the individual.
Cardinality0...0
Typedate
SummaryTrue
Requirements

Age of the individual drives many clinical processes.

Comments

At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: PID-7
  • rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime
  • cda: .patient.birthTime
  • loinc: 21112-8
Patient.deceased[x]
DefinitionIndicates if the individual is deceased or not.
Cardinality0...0
Typeboolean
ModifierTrue
SummaryTrue
Requirements

The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

Comments

If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: PID-30 (bool) and PID-29 (datetime)
  • rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
  • cda: n/a
Patient.address
DefinitionEndereço do indivíduo.
Cardinality0...1
TypeAddress
SummaryTrue
Requirements

Pode ser necessário manter o controle dos endereços dos pacientes para contato, cobrança ou requisitos de relatórios e também para ajudar na identificação.

Comments

O paciente pode ter vários endereços com diferentes usos ou períodos aplicáveis.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XAD
  • rim: AD
  • servd: Address
  • v2: PID-11
  • rim: addr
  • cda: .addr
Patient.address.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Patient.address.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.address.use
DefinitionThe purpose of this address.
Cardinality0...0
Typecode
Binding

The use of an address.

AddressUse (required)
ModifierTrue
SummaryTrue
Requirements

Allows an appropriate address to be chosen from a list of many.

Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

home


Mappings
  • rim: n/a
  • v2: XAD.7
  • rim: unique(./use)
  • servd: ./AddressPurpose
Patient.address.type
DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
Cardinality0...0
Typecode
Binding

The type of an address (physical / postal).

AddressType (required)
SummaryTrue
Comments

The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

both


Mappings
  • rim: n/a
  • v2: XAD.18
  • rim: unique(./use)
  • vcard: address type parameter
Patient.address.text
DefinitionSpecifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.
Cardinality0...0
Typestring
SummaryTrue
Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

137 Nowhere Street, Erewhon 9132


Mappings
  • rim: n/a
  • v2: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
  • rim: ./formatted
  • vcard: address label parameter
Patient.address.line
DefinitionEste componente contém o número da casa, número do apartamento, nome da rua, direção e ponto da rua, Número da caixa postal, dicas de entrega e informações de endereço semelhantes.
Cardinality0...1
Typestring
SummaryTrue
Comments

Observe que as strings FHIR NÃO DEVEM exceder 1 MB de tamanho.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

137 Nowhere Street


Mappings
  • rim: n/a
  • v2: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
  • rim: AD.part[parttype = AL]
  • vcard: street
  • servd: ./StreetAddress (newline delimitted)
Patient.address.city
DefinitionO nome da cidade, vila, subúrbio, vila ou outra comunidade ou centro de entrega.
Cardinality0...1
Typestring
SummaryTrue
AliasMunicpality
Comments

Observe que as strings FHIR NÃO DEVEM exceder 1 MB de tamanho.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

Erewhon


Mappings
  • rim: n/a
  • v2: XAD.3
  • rim: AD.part[parttype = CTY]
  • vcard: locality
  • servd: ./Jurisdiction
Patient.address.district
DefinitionO nome da área administrativa, bairro, distrito ou condado.
Cardinality0...1
Typestring
SummaryTrue
AliasCounty
Comments

O distrito às vezes é conhecido como condado ou bairro, mas em algumas regiões, 'condado' é usado no lugar da cidade (município), portanto, o nome do condado, quando este for o município, deve ser indicado na cidade (city).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

Madison


Mappings
  • rim: n/a
  • v2: XAD.9
  • rim: AD.part[parttype = CNT | CPA]
Patient.address.state
DefinitionSubunidade de um país com soberania limitada em um país organizado federalmente. Um código pode ser usado se houver códigos de uso comum (por exemplo, códigos de estado de 2 letras dos EUA). Utilizado estado no Brasil (Ex: SP/RJ)
Cardinality0...1
Typestring
SummaryTrue
AliasProvince, Territory
Comments

Observe que as strings FHIR NÃO DEVEM exceder 1 MB de tamanho.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XAD.4
  • rim: AD.part[parttype = STA]
  • vcard: region
  • servd: ./Region
Patient.address.postalCode
DefinitionUm código postal ou CEP que designa uma região definida pelo serviço postal.
Cardinality0...1
Typestring
SummaryTrue
AliasZip
Comments

Observe que as strings FHIR NÃO DEVEM exceder 1 MB de tamanho.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

9132


Mappings
  • rim: n/a
  • v2: XAD.5
  • rim: AD.part[parttype = ZIP]
  • vcard: code
  • servd: ./PostalIdentificationCode
Patient.address.country
DefinitionPaís - uma nação como comumente entendida ou geralmente aceita.
Cardinality0...1
Typestring
SummaryTrue
Comments

Códigos ISO 3166 de 3 letras podem ser usados no lugar de um nome de país legível.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XAD.6
  • rim: AD.part[parttype = CNT]
  • vcard: country
  • servd: ./Country
Patient.address.period
DefinitionTime period when address was/is in use.
Cardinality0...0
TypePeriod
SummaryTrue
Requirements

Allows addresses to be placed in historical context.

Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Examples
General

{
  "start": "2010-03-23",
  "end": "2010-07-01"
}


Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2: XAD.12 / XAD.13 + XAD.14
  • rim: ./usablePeriod[type="IVL<TS>"]
  • servd: ./StartDate and ./EndDate
Patient.maritalStatus
DefinitionEste campo contém o estado civil mais recente do paciente.
Cardinality0...1
TypeCodeableConcept
Binding

Estado civil de um indivíduo.

human-marital-status (required)
Requirements

A maioria, senão todos os sistemas, o capturam.

Comments

Nem todos os usos de terminologia se enquadram nesse padrão geral. Em alguns casos, os modelos não devem usar CodeableConcept e usar Coding diretamente e fornecer sua própria estrutura para gerenciar texto, codificações, traduções e a relação entre elementos e pré e pós-coordenação.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: PID-16
  • rim: player[classCode=PSN]/maritalStatusCode
  • cda: .patient.maritalStatusCode
Patient.maritalStatus.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Patient.maritalStatus.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.maritalStatus.coding
DefinitionUma referência a um código definido por um sistema de terminologia.
Cardinality0...1
TypeCoding
SummaryTrue
Requirements

Permite codificações alternativas dentro de um sistema de código e traduções para outros sistemas de código.

Comments

Os códigos podem ser definidos casualmente em enumerações, ou listas de códigos, até definições muito formais, como SNOMED CT - consulte os Princípios Básicos do HL7 v3 para obter mais informações. A ordem das codificações é indefinida e NÃO DEVE ser usada para inferir significado. Geralmente, no máximo apenas um dos valores de codificação será rotulado como UserSelected = true.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Patient.maritalStatus.coding.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Patient.maritalStatus.coding.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.maritalStatus.coding.system
DefinitionA identificação do sistema de código que define o significado do símbolo no código.
Cardinality0...1
Typeuri
SummaryTrue
Requirements

Precisa ser inequívoco sobre a origem da definição do símbolo.

Comments

O URI pode ser um OID (urn: oid: ...) ou um UUID (urn: uuid: ...). OIDs e UUIDs DEVEM ser referências ao registro HL7 OID. Caso contrário, o URI deve vir da lista do HL7 de URIs especiais definidos pelo FHIR ou deve fazer referência a alguma definição que estabeleça o sistema de forma clara e inequívoca.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Patient.maritalStatus.coding.version
DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Cardinality0...0
Typestring
SummaryTrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Patient.maritalStatus.coding.code
DefinitionUm símbolo na sintaxe definida pelo sistema. O símbolo pode ser um código predefinido ou uma expressão em uma sintaxe definida pelo sistema de codificação (por exemplo, pós-coordenação).
Cardinality0...1
Typecode
SummaryTrue
Requirements

Precisa se referir a um código específico no sistema.

Comments

Observe que as strings FHIR NÃO DEVEM exceder 1 MB de tamanho

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Patient.maritalStatus.coding.display
DefinitionUma representação do significado do código no sistema, seguindo as regras do sistema.
Cardinality0...1
Typestring
SummaryTrue
Requirements

Precisa ser capaz de transportar um significado legível do código para leitores que não conhecem o sistema.

Comments

Observe que as strings FHIR NÃO DEVEM exceder 1 MB de tamanho.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Patient.maritalStatus.coding.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...0
Typeboolean
SummaryTrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Patient.maritalStatus.text
DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Cardinality0...0
Typestring
SummaryTrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Patient.multipleBirth[x]
DefinitionIndicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).
Cardinality0...0
Typeboolean
Requirements

For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

Comments

Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: PID-24 (bool), PID-25 (integer)
  • rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber
  • cda: n/a
Patient.photo
DefinitionImage of the patient.
Cardinality0...0
TypeAttachment
Requirements

Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.

Comments

Guidelines:

  • Use id photos, not clinical photos.
  • Limit dimensions to thumbnail.
  • Keep byte count low to ease resource updates.
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • att-1: If the Attachment has data, it SHALL have a contentType
    data.empty() or contentType.exists()
Mappings
  • rim: n/a
  • v2: ED/RP
  • rim: ED
  • v2: OBX-5 - needs a profile
  • rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc
  • cda: n/a
Patient.contact
DefinitionA contact party (e.g. guardian, partner, friend) for the patient.
Cardinality0...0
TypeBackboneElement
Requirements

Need to track people you can contact about the patient.

Comments

Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • pat-1: SHALL at least contain a contact's details or a reference to an organization
    name.exists() or telecom.exists() or address.exists() or organization.exists()
Mappings
  • rim: n/a
  • rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]
  • cda: n/a
Patient.contact.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Patient.contact.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.contact.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.contact.relationship
DefinitionThe nature of the relationship between the patient and the contact person.
Cardinality0...*
TypeCodeableConcept
Binding

The nature of the relationship between a patient and a contact person for that patient.

PatientContactRelationship (extensible)
Requirements

Used to determine which contact person is the most relevant to approach, depending on circumstances.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: NK1-7, NK1-3
  • rim: code
  • cda: n/a
Patient.contact.name
DefinitionA name associated with the contact person.
Cardinality0...1
TypeHumanName
Requirements

Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.

Comments

Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XPN
  • rim: EN (actually, PN)
  • servd: ProviderName
  • v2: NK1-2
  • rim: name
  • cda: n/a
Patient.contact.telecom
DefinitionA contact detail for the person, e.g. a telephone number or an email address.
Cardinality0...*
TypeContactPoint
Requirements

People have (primary) ways to contact them in some way such as phone, email.

Comments

Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cpt-2: A system is required if a value is provided.
    value.empty() or system.exists()
Mappings
  • rim: n/a
  • v2: XTN
  • rim: TEL
  • servd: ContactPoint
  • v2: NK1-5, NK1-6, NK1-40
  • rim: telecom
  • cda: n/a
Patient.contact.address
DefinitionAddress for the contact person.
Cardinality0...1
TypeAddress
Requirements

Need to keep track where the contact person can be contacted per postal mail or visited.

Comments

Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XAD
  • rim: AD
  • servd: Address
  • v2: NK1-4
  • rim: addr
  • cda: n/a
Patient.contact.gender
DefinitionAdministrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.
Cardinality0...1
Typecode
Binding

The gender of a person used for administrative purposes.

AdministrativeGender (required)
Requirements

Needed to address the person correctly.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: NK1-15
  • rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
  • cda: n/a
Patient.contact.organization
DefinitionOrganization on behalf of which the contact is acting or for which the contact is working.
Cardinality0...1
TypeReference(Organization)
Requirements

For guardians or business related contacts, the organization is relevant.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2: NK1-13, NK1-30, NK1-31, NK1-32, NK1-41
  • rim: scoper
  • cda: n/a
Patient.contact.period
DefinitionThe period during which this contact person or organization is valid to be contacted relating to this patient.
Cardinality0...1
TypePeriod
Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • rim: effectiveTime
  • cda: n/a
Patient.communication
DefinitionA language which may be used to communicate with the patient about his or her health.
Cardinality0...0
TypeBackboneElement
Requirements

If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.

Comments

If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: LanguageCommunication
  • cda: patient.languageCommunication
Patient.communication.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Patient.communication.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.communication.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.communication.language
DefinitionThe ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English.
Cardinality1...1
TypeCodeableConcept
Binding

A human language.

CommonLanguages (preferred)
Requirements

Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.

Comments

The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: PID-15, LAN-2
  • rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code
  • cda: .languageCode
Patient.communication.preferred
DefinitionIndicates whether or not the patient prefers this language (over other languages he masters up a certain level).
Cardinality0...1
Typeboolean
Requirements

People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.

Comments

This language is specifically identified for communicating healthcare information.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: PID-15
  • rim: preferenceInd
  • cda: .preferenceInd
Patient.generalPractitioner
DefinitionPatient's nominated care provider.
Cardinality0...0
TypeReference(Organization | Practitioner | PractitionerRole)
AliascareProvider
Comments

This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues.

Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2: PD1-4
  • rim: subjectOf.CareEvent.performer.AssignedEntity
  • cda: n/a
Patient.managingOrganization
DefinitionOrganization that is the custodian of the patient record.
Cardinality0...0
TypeReference(Organization)
SummaryTrue
Requirements

Need to know who recognizes this patient record, manages and updates it.

Comments

There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: scoper
  • cda: .providerOrganization
Patient.link
DefinitionLink to another patient resource that concerns the same actual patient.
Cardinality0...0
TypeBackboneElement
ModifierTrue
SummaryTrue
Requirements

There are multiple use cases:

  • Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and
  • Distribution of patient information across multiple servers.
Comments

There is no assumption that linked patient records have mutual links.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: outboundLink
  • cda: n/a
Patient.link.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Patient.link.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.link.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Patient.link.other
DefinitionThe other patient resource that the link refers to.
Cardinality1...1
TypeReference(Patient | RelatedPerson)
SummaryTrue
Comments

Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2: PID-3, MRG-1
  • rim: id
  • cda: n/a
Patient.link.type
DefinitionThe type of link between this patient resource and another patient resource.
Cardinality1...1
Typecode
Binding

The type of link between this patient resource and another patient resource.

LinkType (required)
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: typeCode
  • cda: n/a


JSON

{
    "resourceType": "StructureDefinition",
    "url": "https://www.samisaude.com.br/fhir/r4/StructureDefinition/MyPatient",
    "name": "Paciente",
    "status": "active",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Patient",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Patient",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Patient",
                "path": "Patient",
                "short": "Informações sobre um indivíduo que recebe serviços de saúde",
                "definition": "Dados populacionais, demográficos e outras informações administrativas sobre um indivíduo recebendo cuidados ou outros serviços relacionados à saúde.",
                "comment": "Informações sobre um indivíduo que recebe serviços de saúde."
            },
            {
                "id": "Patient.extension",
                "path": "Patient.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                },
                "min": 0
            },
            {
                "id": "Patient.extension:mothersName",
                "path": "Patient.extension",
                "sliceName": "mothersName",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.extension:Geolocation",
                "path": "Patient.extension",
                "sliceName": "Geolocation",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://hl7.org/fhir/StructureDefinition/geolocation"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.extension:PatientNationality",
                "path": "Patient.extension",
                "sliceName": "PatientNationality",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://hl7.org/fhir/StructureDefinition/patient-nationality"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.extension:PatientNationality.extension",
                "path": "Patient.extension.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                },
                "min": 0
            },
            {
                "id": "Patient.extension:PatientNationality.extension:code",
                "path": "Patient.extension.extension",
                "sliceName": "code",
                "min": 0,
                "binding": {
                    "strength": "required",
                    "description": "Nacionalidade de um indivíduo.",
                    "valueSet": "https://www.samisaude.com.br/fhir/r4/CodeSystem/nationality"
                }
            },
            {
                "id": "Patient.extension:PatientNationality.extension:period",
                "path": "Patient.extension.extension",
                "sliceName": "period",
                "min": 0,
                "max": "0"
            },
            {
                "id": "Patient.extension:PatientImmigration",
                "path": "Patient.extension",
                "sliceName": "PatientImmigration",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://hl7.org/fhir/StructureDefinition/patient-citizenship"
                        ]
                    }
                ],
                "binding": {
                    "strength": "extensible",
                    "valueSet": "https://www.samisaude.com.br/fhir/r4/CodeSystem/nationality"
                }
            },
            {
                "id": "Patient.extension:PatientScholarity",
                "path": "Patient.extension",
                "sliceName": "PatientScholarity",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://www.samisaude.com.br/fhir/r4/CodeSystem/human-scholarity"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.extension:PatientScholarity.value[x]",
                "path": "Patient.extension.value[x]",
                "short": "PatientScholarity",
                "binding": {
                    "strength": "required",
                    "valueSet": "https://www.samisaude.com.br/fhir/r4/CodeSystem/human-scholarity"
                }
            },
            {
                "id": "Patient.extension:PatientBirthPlace",
                "path": "Patient.extension",
                "sliceName": "PatientBirthPlace",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.extension:PatientBirthPlace.value[x]",
                "path": "Patient.extension.value[x]",
                "short": "PatientBirthPlace"
            },
            {
                "id": "Patient.extension:PatientBirthPlace.value[x].use",
                "path": "Patient.extension.value[x].use",
                "max": "0"
            },
            {
                "id": "Patient.extension:PatientBirthPlace.value[x].type",
                "path": "Patient.extension.value[x].type",
                "max": "0"
            },
            {
                "id": "Patient.extension:PatientBirthPlace.value[x].text",
                "path": "Patient.extension.value[x].text",
                "max": "0"
            },
            {
                "id": "Patient.extension:PatientBirthPlace.value[x].line",
                "path": "Patient.extension.value[x].line",
                "short": "Nome da rua, número, direção e ponto, Caixa postal, etc.",
                "definition": "Este componente contém o número da casa, número do apartamento, nome da rua, direção e ponto da rua,  Número da caixa postal, dicas de entrega e informações de endereço semelhantes.",
                "comment": "Observe que as strings FHIR NÃO DEVEM exceder 1 MB de tamanho.",
                "max": "0",
                "orderMeaning": "A ordem em que as linhas devem aparecer em uma etiqueta de endereço"
            },
            {
                "id": "Patient.extension:PatientBirthPlace.value[x].city",
                "path": "Patient.extension.value[x].city",
                "short": "Nome da cidade, município etc.",
                "definition": "O nome da cidade, vila, subúrbio, vila ou outra comunidade ou centro de entrega.",
                "comment": "Observe que as strings FHIR NÃO DEVEM exceder 1 MB de tamanho."
            },
            {
                "id": "Patient.extension:PatientBirthPlace.value[x].district",
                "path": "Patient.extension.value[x].district",
                "max": "0"
            },
            {
                "id": "Patient.extension:PatientBirthPlace.value[x].state",
                "path": "Patient.extension.value[x].state",
                "short": "Subunidade do país | Estado (abreviações ok)",
                "definition": "Subunidade de um país com soberania limitada em um país organizado federalmente. Um código pode ser usado se houver códigos de uso comum (por exemplo, códigos de estado de 2 letras dos EUA). Utilizado estado no Brasil (Ex: SP/RJ)"
            },
            {
                "id": "Patient.extension:PatientBirthPlace.value[x].postalCode",
                "path": "Patient.extension.value[x].postalCode",
                "max": "0"
            },
            {
                "id": "Patient.extension:PatientBirthPlace.value[x].country",
                "path": "Patient.extension.value[x].country",
                "max": "0"
            },
            {
                "id": "Patient.extension:PatientBirthPlace.value[x].period",
                "path": "Patient.extension.value[x].period",
                "max": "0"
            },
            {
                "id": "Patient.extension:PatientBirthTime",
                "path": "Patient.extension",
                "sliceName": "PatientBirthTime",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://hl7.org/fhir/StructureDefinition/patient-birthTime"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.extension:PatientBirthTime.value[x]",
                "path": "Patient.extension.value[x]",
                "short": "PatientBirthTime"
            },
            {
                "id": "Patient.extension:PatientDeathTime",
                "path": "Patient.extension",
                "sliceName": "PatientDeathTime",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://www.samisaude.com.br/fhir/r4/StructureDefinition/patient-deathTime"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.extension:PatientDeathTime.value[x]",
                "path": "Patient.extension.value[x]",
                "short": "PatientDeathTime"
            },
            {
                "id": "Patient.extension:HumanRace",
                "path": "Patient.extension",
                "sliceName": "HumanRace",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://www.samisaude.com.br/fhir/r4/CodeSystem/human-race"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.extension:HumanRace.value[x]",
                "path": "Patient.extension.value[x]",
                "short": "HumanRace",
                "binding": {
                    "strength": "required",
                    "valueSet": "https://www.samisaude.com.br/fhir/r4/CodeSystem/human-race"
                }
            },
            {
                "id": "Patient.extension:HumanGender",
                "path": "Patient.extension",
                "sliceName": "HumanGender",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://www.samisaude.com.br/fhir/r4/CodeSystem/human-gender"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.extension:HumanGender.value[x].coding",
                "path": "Patient.extension.value[x].coding",
                "short": "Código definido por um sistema de terminologia",
                "definition": "Uma referência a um código definido por um sistema de terminologia.",
                "comment": "Os códigos podem ser definidos casualmente em enumerações, ou listas de códigos, até definições muito formais, como SNOMED CT - consulte os Princípios Básicos do HL7 v3 para obter mais informações. A ordem das codificações é indefinida e NÃO DEVE ser usada para inferir significado. Geralmente, no máximo apenas um dos valores de codificação será rotulado como UserSelected = true.",
                "requirements": "Permite codificações alternativas dentro de um sistema de código e traduções para outros sistemas de código."
            },
            {
                "id": "Patient.identifier",
                "path": "Patient.identifier",
                "short": "cpf | rg | cartao plano saude | cartao sus",
                "definition": "Identificador único do paciente.",
                "comment": "Identificador do paciente, pode ser o número da carteirinha Sami, o cartão nacional de saúde, CPF ou RG",
                "requirements": "Os pacientes quase sempre recebem identificadores numéricos específicos.",
                "min": 1,
                "max": "1"
            },
            {
                "id": "Patient.identifier.use",
                "path": "Patient.identifier.use",
                "definition": "O propósito deste é o identificador único.",
                "comment": "Os aplicativos podem presumir que um identificador é permanente, a menos que diga explicitamente que é temporário.",
                "requirements": "Permite que o identificador apropriado para um determinado contexto de uso seja selecionado entre um conjunto de identificadores.",
                "min": 1
            },
            {
                "id": "Patient.identifier.type",
                "path": "Patient.identifier.type",
                "max": "0"
            },
            {
                "id": "Patient.identifier.system",
                "path": "Patient.identifier.system",
                "short": "O namespace para o valor do identificador",
                "definition": "Estabelece o namespace para o valor - ou seja, uma URL que descreve um conjunto de valores que são exclusivos.",
                "max": "0"
            },
            {
                "id": "Patient.identifier.value",
                "path": "Patient.identifier.value",
                "max": "0"
            },
            {
                "id": "Patient.identifier.period",
                "path": "Patient.identifier.period",
                "max": "0"
            },
            {
                "id": "Patient.identifier.assigner",
                "path": "Patient.identifier.assigner",
                "max": "0"
            },
            {
                "id": "Patient.active",
                "path": "Patient.active",
                "short": "Se o registro deste paciente está em uso ativo.",
                "definition": "Se este registro do paciente está em uso ativo.\nMuitos sistemas usam essa propriedade para marcar como pacientes não atuais, como aqueles que não foram vistos por um período de tempo com base nas regras de negócios de uma organização.\n\nÉ frequentemente usado para filtrar listas de pacientes para excluir pacientes inativos\n\nPacientes falecidos também podem ser marcados como inativos pelos mesmos motivos, mas podem permanecer ativos por algum tempo após a morte.",
                "comment": "Se um registro estiver inativo e vinculado a um registro ativo, as atualizações futuras do paciente / registro devem ocorrer no outro paciente.",
                "requirements": "Precisa ser capaz de marcar um registro de paciente como não para ser usado porque foi criado por engano."
            },
            {
                "id": "Patient.name",
                "path": "Patient.name",
                "label": "Nome",
                "short": "Nome do indivíduo",
                "definition": "Nome do indivíduo.",
                "comment": "Um paciente/indivíduo pode ter vários nomes com diferentes usos ou períodos aplicáveis.",
                "requirements": "Precisa ser capaz de rastrear o paciente por vários nomes. Exemplos são: seu civil ou seu nome social.",
                "max": "1"
            },
            {
                "id": "Patient.name.use",
                "path": "Patient.name.use",
                "definition": "Identifica a finalidade do nome.",
                "comment": "Os aplicativos podem assumir que um nome é atual, a menos que diga explicitamente que é temporário ou antigo.",
                "requirements": "Permite que o nome apropriado para um determinado contexto de uso seja selecionado entre um conjunto de nomes.",
                "isModifierReason": "Isso é rotulado como \"É modificador\" porque os aplicativos não devem confundir um nome temporário ou antigo etc. com um atual / permanente",
                "binding": {
                    "strength": "required",
                    "description": "O uso de um nome humano."
                }
            },
            {
                "id": "Patient.name.text",
                "path": "Patient.name.text",
                "short": "Representação de texto do nome",
                "definition": "Especifica o nome completo como deve ser exibido, por exemplo, em uma UI do aplicativo. Isso pode ser fornecido em vez de ou junto com as peças específicas.",
                "comment": "Pode fornecer uma representação de texto e partes. Os aplicativos que atualizam um nome DEVEM garantir que, quando o texto e as partes estiverem presentes, nenhum conteúdo seja incluído no texto que não seja encontrado em uma parte.",
                "requirements": "Um formulário não codificado e passível de renderização."
            },
            {
                "id": "Patient.name.family",
                "path": "Patient.name.family",
                "max": "0"
            },
            {
                "id": "Patient.name.given",
                "path": "Patient.name.given",
                "short": "Nomes próprios (nem sempre 'primeiro'). Inclui nomes do meio",
                "definition": "Nome dado.",
                "comment": "Se apenas as iniciais forem registradas, elas podem ser usadas no lugar das partes do nome completo. As iniciais podem ser separadas em vários nomes, mas geralmente não são devido a limitações paráticas. Este elemento não é chamado de \"primeiro nome\", pois os nomes dados nem sempre vêm em primeiro lugar.",
                "max": "0",
                "orderMeaning": "Os nomes dados aparecem na ordem correta para apresentar o nome"
            },
            {
                "id": "Patient.name.prefix",
                "path": "Patient.name.prefix",
                "max": "0"
            },
            {
                "id": "Patient.name.suffix",
                "path": "Patient.name.suffix",
                "max": "0"
            },
            {
                "id": "Patient.name.period",
                "path": "Patient.name.period",
                "max": "0"
            },
            {
                "id": "Patient.telecom",
                "path": "Patient.telecom",
                "short": "Detalhes de contato de um indivíduo",
                "definition": "Detalhes de contato (por exemplo, um número de telefone ou um endereço de e-mail) pelo qual o indivíduo pode ser contatado.",
                "comment": "Um paciente pode ter várias maneiras de ser contatado com diferentes usos ou períodos aplicáveis. Pode ser necessário ter opções para entrar em contato com a pessoa com urgência e também para ajudar na identificação. O endereço pode não ir diretamente para o indivíduo, mas pode chegar a outra parte que pode representar o paciente (por exemplo, telefone residencial ou telefone comercial).",
                "requirements": "As pessoas têm maneiras (principais) de contatá-las de alguma forma, como telefone, e-mail."
            },
            {
                "id": "Patient.telecom.system",
                "path": "Patient.telecom.system",
                "definition": "Formulário de telecomunicações para ponto de contato - qual sistema de comunicação é necessário para fazer uso do contato.",
                "comment": "Observe que as strings FHIR NÃO DEVEM exceder 1 MB de tamanho."
            },
            {
                "id": "Patient.telecom.value",
                "path": "Patient.telecom.value",
                "short": "Detalhes atuais do ponto de contato",
                "definition": "Os detalhes atuais do ponto de contato, em uma forma que seja significativa para o sistema de comunicação designado (ou seja, número de telefone ou endereço de e-mail).",
                "comment": "Dados de texto adicionais, como números de ramais de telefone ou notas sobre o uso do contato, às vezes são incluídos no valor.",
                "requirements": "Precisa oferecer suporte a números legados que não estão em um formato rigidamente controlado."
            },
            {
                "id": "Patient.telecom.use",
                "path": "Patient.telecom.use",
                "definition": "Identifica a finalidade do ponto de contato.",
                "comment": "Os aplicativos podem presumir que um contato é atual, a menos que diga explicitamente que é temporário ou antigo.",
                "requirements": "Precisa rastrear a maneira como uma pessoa usa esse contato, para que o usuário possa escolher qual é apropriado para sua finalidade.",
                "isModifierReason": "Isso é rotulado como \"É modificador\" porque os aplicativos não devem confundir um contato temporário ou antigo etc. com um atual / permanente"
            },
            {
                "id": "Patient.telecom.rank",
                "path": "Patient.telecom.rank",
                "max": "0"
            },
            {
                "id": "Patient.telecom.period",
                "path": "Patient.telecom.period",
                "max": "0"
            },
            {
                "id": "Patient.gender",
                "path": "Patient.gender",
                "max": "0"
            },
            {
                "id": "Patient.birthDate",
                "path": "Patient.birthDate",
                "max": "0"
            },
            {
                "id": "Patient.deceased[x]",
                "path": "Patient.deceased[x]",
                "max": "0"
            },
            {
                "id": "Patient.address",
                "path": "Patient.address",
                "short": "Endereço do indivíduo",
                "definition": "Endereço do indivíduo.",
                "comment": "O paciente pode ter vários endereços com diferentes usos ou períodos aplicáveis.",
                "requirements": "Pode ser necessário manter o controle dos endereços dos pacientes para contato, cobrança ou requisitos de relatórios e também para ajudar na identificação.",
                "max": "1"
            },
            {
                "id": "Patient.address.use",
                "path": "Patient.address.use",
                "max": "0"
            },
            {
                "id": "Patient.address.type",
                "path": "Patient.address.type",
                "max": "0"
            },
            {
                "id": "Patient.address.text",
                "path": "Patient.address.text",
                "max": "0"
            },
            {
                "id": "Patient.address.line",
                "path": "Patient.address.line",
                "short": "Nome da rua, número, direção e ponto, Caixa postal, etc.",
                "definition": "Este componente contém o número da casa, número do apartamento, nome da rua, direção e ponto da rua,  Número da caixa postal, dicas de entrega e informações de endereço semelhantes.",
                "comment": "Observe que as strings FHIR NÃO DEVEM exceder 1 MB de tamanho.",
                "max": "1"
            },
            {
                "id": "Patient.address.city",
                "path": "Patient.address.city",
                "short": "Nome da cidade, município etc.",
                "definition": "O nome da cidade, vila, subúrbio, vila ou outra comunidade ou centro de entrega.",
                "comment": "Observe que as strings FHIR NÃO DEVEM exceder 1 MB de tamanho."
            },
            {
                "id": "Patient.address.district",
                "path": "Patient.address.district",
                "short": "Nome do distrito/ Bairro (também conhecido como condado)",
                "definition": "O nome da área administrativa, bairro, distrito ou condado.",
                "comment": "O distrito às vezes é conhecido como condado ou bairro, mas em algumas regiões, 'condado' é usado no lugar da cidade (município), portanto, o nome do condado, quando este for o município, deve ser indicado na cidade (city)."
            },
            {
                "id": "Patient.address.state",
                "path": "Patient.address.state",
                "short": "Subunidade do país | Estado (abreviações ok)",
                "definition": "Subunidade de um país com soberania limitada em um país organizado federalmente. Um código pode ser usado se houver códigos de uso comum (por exemplo, códigos de estado de 2 letras dos EUA). Utilizado estado no Brasil (Ex: SP/RJ)",
                "comment": "Observe que as strings FHIR NÃO DEVEM exceder 1 MB de tamanho."
            },
            {
                "id": "Patient.address.postalCode",
                "path": "Patient.address.postalCode",
                "short": "Código postal  ou CEP da área",
                "definition": "Um código postal ou CEP que designa uma região definida pelo serviço postal.",
                "comment": "Observe que as strings FHIR NÃO DEVEM exceder 1 MB de tamanho."
            },
            {
                "id": "Patient.address.country",
                "path": "Patient.address.country",
                "short": "País",
                "definition": "País - uma nação como comumente entendida ou geralmente aceita.",
                "comment": "Códigos ISO 3166 de 3 letras podem ser usados no lugar de um nome de país legível."
            },
            {
                "id": "Patient.address.period",
                "path": "Patient.address.period",
                "max": "0"
            },
            {
                "id": "Patient.maritalStatus",
                "path": "Patient.maritalStatus",
                "short": "Estado civil de um paciente",
                "definition": "Este campo contém o estado civil mais recente do paciente.",
                "comment": "Nem todos os usos de terminologia se enquadram nesse padrão geral. Em alguns casos, os modelos não devem usar CodeableConcept e usar Coding diretamente e fornecer sua própria estrutura para gerenciar texto, codificações, traduções e a relação entre elementos e pré e pós-coordenação.",
                "requirements": "A maioria, senão todos os sistemas, o capturam.",
                "binding": {
                    "strength": "required",
                    "description": "Estado civil de um indivíduo.",
                    "valueSet": "https://www.samisaude.com.br/fhir/r4/CodeSystem/human-marital-status"
                }
            },
            {
                "id": "Patient.maritalStatus.coding",
                "path": "Patient.maritalStatus.coding",
                "short": "Código definido por um sistema de terminologia",
                "definition": "Uma referência a um código definido por um sistema de terminologia.",
                "comment": "Os códigos podem ser definidos casualmente em enumerações, ou listas de códigos, até definições muito formais, como SNOMED CT - consulte os Princípios Básicos do HL7 v3 para obter mais informações. A ordem das codificações é indefinida e NÃO DEVE ser usada para inferir significado. Geralmente, no máximo apenas um dos valores de codificação será rotulado como UserSelected = true.",
                "requirements": "Permite codificações alternativas dentro de um sistema de código e traduções para outros sistemas de código.",
                "max": "1"
            },
            {
                "id": "Patient.maritalStatus.coding.system",
                "path": "Patient.maritalStatus.coding.system",
                "short": "Identidade do sistema de terminologia",
                "definition": "A identificação do sistema de código que define o significado do símbolo no código.",
                "comment": "O URI pode ser um OID (urn: oid: ...) ou um UUID (urn: uuid: ...). OIDs e UUIDs DEVEM ser referências ao registro HL7 OID. Caso contrário, o URI deve vir da lista do HL7 de URIs especiais definidos pelo FHIR ou deve fazer referência a alguma definição que estabeleça o sistema de forma clara e inequívoca.",
                "requirements": "Precisa ser inequívoco sobre a origem da definição do símbolo."
            },
            {
                "id": "Patient.maritalStatus.coding.version",
                "path": "Patient.maritalStatus.coding.version",
                "max": "0"
            },
            {
                "id": "Patient.maritalStatus.coding.code",
                "path": "Patient.maritalStatus.coding.code",
                "short": "Símbolo na sintaxe definida pelo sistema",
                "definition": "Um símbolo na sintaxe definida pelo sistema. O símbolo pode ser um código predefinido ou uma expressão em uma sintaxe definida pelo sistema de codificação (por exemplo, pós-coordenação).",
                "comment": "Observe que as strings FHIR NÃO DEVEM exceder 1 MB de tamanho",
                "requirements": "Precisa se referir a um código específico no sistema."
            },
            {
                "id": "Patient.maritalStatus.coding.display",
                "path": "Patient.maritalStatus.coding.display",
                "short": "Representação definida pelo sistema",
                "definition": "Uma representação do significado do código no sistema, seguindo as regras do sistema.",
                "comment": "Observe que as strings FHIR NÃO DEVEM exceder 1 MB de tamanho.",
                "requirements": "Precisa ser capaz de transportar um significado legível do código para leitores que não conhecem o sistema."
            },
            {
                "id": "Patient.maritalStatus.coding.userSelected",
                "path": "Patient.maritalStatus.coding.userSelected",
                "max": "0"
            },
            {
                "id": "Patient.maritalStatus.text",
                "path": "Patient.maritalStatus.text",
                "max": "0"
            },
            {
                "id": "Patient.multipleBirth[x]",
                "path": "Patient.multipleBirth[x]",
                "max": "0"
            },
            {
                "id": "Patient.photo",
                "path": "Patient.photo",
                "max": "0"
            },
            {
                "id": "Patient.contact",
                "path": "Patient.contact",
                "max": "0"
            },
            {
                "id": "Patient.communication",
                "path": "Patient.communication",
                "max": "0"
            },
            {
                "id": "Patient.generalPractitioner",
                "path": "Patient.generalPractitioner",
                "max": "0"
            },
            {
                "id": "Patient.managingOrganization",
                "path": "Patient.managingOrganization",
                "max": "0"
            },
            {
                "id": "Patient.link",
                "path": "Patient.link",
                "max": "0"
            }
        ]
    }
}