Guia de Implementação do AnHealth
0.2.0 - CI Build

Guia de Implementação do AnHealth - Local Development build (v0.2.0). See the Directory of published versions

Resource Profile: Patient

Official URL: https://ancode.app/fhir/StructureDefinition/Patient Version: 0.2.0
Draft as of 2021-11-10 Computable Name: Patient

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... birthCity 0..1stringExtension
URL: https://ancode.app/fhir/StructureDefinition/City
... nacionality 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/Country
Binding: Country (required): Country

... race 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/Race
Binding: Race (required): Race

... occupation 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/Occupation
Binding: BRCBO (required): Occupation

... motherName 0..1stringExtension
URL: https://ancode.app/fhir/StructureDefinition/MotherName
... ethnicity 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/Ethnicity
Binding: BREtnia (required): Ethnicity

... educationLevel 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/EducationLevel
Binding: BRNivelEscolaridade (required): EducationLevel

... birthSex 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/BirthSex
Binding: AdministrativeGender (required): BirthSex

... identifier C0..*IdentifierAn identifier intended for computation
.... type 0..1CodeableConceptDescription of identifier
Binding: IdentifierTypePerson (required)
... active 1..1booleanWhether this patient's record is in active use
... name 1..*HumanNameName of a human - parts and usage
... telecom 0..*ContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
... gender 1..1codemale | female | other | unknown
... deceased[x] 0..1dateTimeIndicates if the individual is deceased or not
... address 0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: BrazilianMaritalStatus (required)
... multipleBirth[x] 0..1booleanWhether patient is part of a multiple birth
... photo 0..1AttachmentImage of the patient
.... contentType 0..1codeMime type of the content, with charset etc.
Binding: MimeType (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Patient.identifier.typerequiredIdentifierTypePerson
Patient.maritalStatusrequiredBrazilianMaritalStatus
Patient.photo.contentTyperequiredMimeType

Constraints

IdGradePath(s)DetailsRequirements
ide-1errorPatient.identifierThe Resource must have at least one Oficial Identifier
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... birthCity 0..1stringExtension
URL: https://ancode.app/fhir/StructureDefinition/City
... protectedPerson 1..1booleanOptional Extensions Element
URL: https://ancode.app/fhir/StructureDefinition/ProtectedPerson
... race 0..1CodeableConceptOptional Extensions Element
URL: https://ancode.app/fhir/StructureDefinition/Race
Binding: Race (required): Race


... occupation 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/Occupation
Binding: BRCBO (required): Occupation


... motherName 0..1stringExtension
URL: https://ancode.app/fhir/StructureDefinition/MotherName
... ethnicity 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/Ethnicity
Binding: BREtnia (required): Ethnicity


... educationLevel 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/EducationLevel
Binding: BRNivelEscolaridade (required): EducationLevel


... birthSex 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/BirthSex
Binding: AdministrativeGender (required): BirthSex


... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier C0..*IdentifierAn identifier intended for computation
.... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: IdentifierTypePerson (required)
..... coding Σ1..1CodingCode defined by a terminology system
.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
... active ?!Σ1..1booleanWhether this patient's record is in active use
... name 1..*HumanNameName of a human - parts and usage
... telecom C0..*ContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
... gender Σ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... deceased[x] ?!Σ0..1dateTimeIndicates if the individual is deceased or not
... address 0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: BrazilianMaritalStatus (required)
... multipleBirth[x] 0..1booleanWhether patient is part of a multiple birth
... photo 0..1AttachmentImage of the patient
.... contentType Σ0..1codeMime type of the content, with charset etc.
Binding: MimeType (required)
Example General: text/plain; charset=UTF-8, image/png
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Patient.identifier.userequiredIdentifierUse
Patient.identifier.typerequiredIdentifierTypePerson
Patient.genderrequiredAdministrativeGender
Patient.maritalStatusrequiredBrazilianMaritalStatus
Patient.photo.contentTyperequiredMimeType
Patient.link.typerequiredLinkType

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorPatient.telecomA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ide-1errorPatient.identifierThe Resource must have at least one Oficial Identifier
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... birthCity 0..1stringExtension
URL: https://ancode.app/fhir/StructureDefinition/City
... nacionality 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/Country
Binding: Country (required): Country


... protectedPerson 1..1booleanOptional Extensions Element
URL: https://ancode.app/fhir/StructureDefinition/ProtectedPerson
... race 0..1CodeableConceptOptional Extensions Element
URL: https://ancode.app/fhir/StructureDefinition/Race
Binding: Race (required): Race


... occupation 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/Occupation
Binding: BRCBO (required): Occupation


... motherName 0..1stringExtension
URL: https://ancode.app/fhir/StructureDefinition/MotherName
... ethnicity 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/Ethnicity
Binding: BREtnia (required): Ethnicity


... educationLevel 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/EducationLevel
Binding: BRNivelEscolaridade (required): EducationLevel


... birthSex 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/BirthSex
Binding: AdministrativeGender (required): BirthSex


... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier C0..*IdentifierAn identifier intended for computation
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: IdentifierTypePerson (required)
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..1CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
..... type Σ1..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
...... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
...... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
...... value Σ1..1stringThe value that is unique
Example General: 123456
...... period Σ0..1PeriodTime period when id is/was valid for use
...... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
..... display Σ1..1stringText alternative for the resource
... active ?!Σ1..1booleanWhether this patient's record is in active use
... name 1..*HumanNameName of a human - parts and usage
... telecom C0..*ContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
... gender Σ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date of birth for the individual
... deceased[x] ?!Σ0..1dateTimeIndicates if the individual is deceased or not
... address 0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: BrazilianMaritalStatus (required)
... multipleBirth[x] 0..1booleanWhether patient is part of a multiple birth
... photo 0..1AttachmentImage of the patient
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contentType Σ0..1codeMime type of the content, with charset etc.
Binding: MimeType (required)
Example General: text/plain; charset=UTF-8, image/png
.... language Σ0..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding

Example General: en-AU
.... data 0..1base64BinaryData inline, base64ed
.... url Σ0..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
.... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
.... title Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
.... creation Σ0..1dateTimeDate attachment was first created
... contact C0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.identifier.userequiredIdentifierUse
Patient.identifier.typerequiredIdentifierTypePerson
Patient.identifier.assigner.typeextensibleResourceType
Patient.identifier.assigner.identifier.userequiredIdentifierUse
Patient.identifier.assigner.identifier.typeextensibleIdentifier Type Codes
Patient.genderrequiredAdministrativeGender
Patient.maritalStatusrequiredBrazilianMaritalStatus
Patient.photo.contentTyperequiredMimeType
Patient.photo.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.contact.relationshipextensiblePatientContactRelationship
Patient.contact.genderrequiredAdministrativeGender
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorPatient.telecomA system is required if a value is provided.
: value.empty() or system.exists()
dom-r4bwarningPatient.containedContaining new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
: ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ide-1errorPatient.identifierThe Resource must have at least one Oficial Identifier
:
pat-1errorPatient.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... birthCity 0..1stringExtension
URL: https://ancode.app/fhir/StructureDefinition/City
... nacionality 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/Country
Binding: Country (required): Country

... race 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/Race
Binding: Race (required): Race

... occupation 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/Occupation
Binding: BRCBO (required): Occupation

... motherName 0..1stringExtension
URL: https://ancode.app/fhir/StructureDefinition/MotherName
... ethnicity 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/Ethnicity
Binding: BREtnia (required): Ethnicity

... educationLevel 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/EducationLevel
Binding: BRNivelEscolaridade (required): EducationLevel

... birthSex 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/BirthSex
Binding: AdministrativeGender (required): BirthSex

... identifier C0..*IdentifierAn identifier intended for computation
.... type 0..1CodeableConceptDescription of identifier
Binding: IdentifierTypePerson (required)
... active 1..1booleanWhether this patient's record is in active use
... name 1..*HumanNameName of a human - parts and usage
... telecom 0..*ContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
... gender 1..1codemale | female | other | unknown
... deceased[x] 0..1dateTimeIndicates if the individual is deceased or not
... address 0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: BrazilianMaritalStatus (required)
... multipleBirth[x] 0..1booleanWhether patient is part of a multiple birth
... photo 0..1AttachmentImage of the patient
.... contentType 0..1codeMime type of the content, with charset etc.
Binding: MimeType (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Patient.identifier.typerequiredIdentifierTypePerson
Patient.maritalStatusrequiredBrazilianMaritalStatus
Patient.photo.contentTyperequiredMimeType

Constraints

IdGradePath(s)DetailsRequirements
ide-1errorPatient.identifierThe Resource must have at least one Oficial Identifier
:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... birthCity 0..1stringExtension
URL: https://ancode.app/fhir/StructureDefinition/City
... protectedPerson 1..1booleanOptional Extensions Element
URL: https://ancode.app/fhir/StructureDefinition/ProtectedPerson
... race 0..1CodeableConceptOptional Extensions Element
URL: https://ancode.app/fhir/StructureDefinition/Race
Binding: Race (required): Race


... occupation 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/Occupation
Binding: BRCBO (required): Occupation


... motherName 0..1stringExtension
URL: https://ancode.app/fhir/StructureDefinition/MotherName
... ethnicity 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/Ethnicity
Binding: BREtnia (required): Ethnicity


... educationLevel 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/EducationLevel
Binding: BRNivelEscolaridade (required): EducationLevel


... birthSex 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/BirthSex
Binding: AdministrativeGender (required): BirthSex


... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier C0..*IdentifierAn identifier intended for computation
.... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: IdentifierTypePerson (required)
..... coding Σ1..1CodingCode defined by a terminology system
.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
... active ?!Σ1..1booleanWhether this patient's record is in active use
... name 1..*HumanNameName of a human - parts and usage
... telecom C0..*ContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
... gender Σ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... deceased[x] ?!Σ0..1dateTimeIndicates if the individual is deceased or not
... address 0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: BrazilianMaritalStatus (required)
... multipleBirth[x] 0..1booleanWhether patient is part of a multiple birth
... photo 0..1AttachmentImage of the patient
.... contentType Σ0..1codeMime type of the content, with charset etc.
Binding: MimeType (required)
Example General: text/plain; charset=UTF-8, image/png
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Patient.identifier.userequiredIdentifierUse
Patient.identifier.typerequiredIdentifierTypePerson
Patient.genderrequiredAdministrativeGender
Patient.maritalStatusrequiredBrazilianMaritalStatus
Patient.photo.contentTyperequiredMimeType
Patient.link.typerequiredLinkType

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorPatient.telecomA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ide-1errorPatient.identifierThe Resource must have at least one Oficial Identifier
:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... birthCity 0..1stringExtension
URL: https://ancode.app/fhir/StructureDefinition/City
... nacionality 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/Country
Binding: Country (required): Country


... protectedPerson 1..1booleanOptional Extensions Element
URL: https://ancode.app/fhir/StructureDefinition/ProtectedPerson
... race 0..1CodeableConceptOptional Extensions Element
URL: https://ancode.app/fhir/StructureDefinition/Race
Binding: Race (required): Race


... occupation 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/Occupation
Binding: BRCBO (required): Occupation


... motherName 0..1stringExtension
URL: https://ancode.app/fhir/StructureDefinition/MotherName
... ethnicity 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/Ethnicity
Binding: BREtnia (required): Ethnicity


... educationLevel 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/EducationLevel
Binding: BRNivelEscolaridade (required): EducationLevel


... birthSex 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/BirthSex
Binding: AdministrativeGender (required): BirthSex


... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier C0..*IdentifierAn identifier intended for computation
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: IdentifierTypePerson (required)
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..1CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
..... type Σ1..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
...... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
...... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
...... value Σ1..1stringThe value that is unique
Example General: 123456
...... period Σ0..1PeriodTime period when id is/was valid for use
...... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
..... display Σ1..1stringText alternative for the resource
... active ?!Σ1..1booleanWhether this patient's record is in active use
... name 1..*HumanNameName of a human - parts and usage
... telecom C0..*ContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
... gender Σ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date of birth for the individual
... deceased[x] ?!Σ0..1dateTimeIndicates if the individual is deceased or not
... address 0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: BrazilianMaritalStatus (required)
... multipleBirth[x] 0..1booleanWhether patient is part of a multiple birth
... photo 0..1AttachmentImage of the patient
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contentType Σ0..1codeMime type of the content, with charset etc.
Binding: MimeType (required)
Example General: text/plain; charset=UTF-8, image/png
.... language Σ0..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding

Example General: en-AU
.... data 0..1base64BinaryData inline, base64ed
.... url Σ0..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
.... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
.... title Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
.... creation Σ0..1dateTimeDate attachment was first created
... contact C0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.identifier.userequiredIdentifierUse
Patient.identifier.typerequiredIdentifierTypePerson
Patient.identifier.assigner.typeextensibleResourceType
Patient.identifier.assigner.identifier.userequiredIdentifierUse
Patient.identifier.assigner.identifier.typeextensibleIdentifier Type Codes
Patient.genderrequiredAdministrativeGender
Patient.maritalStatusrequiredBrazilianMaritalStatus
Patient.photo.contentTyperequiredMimeType
Patient.photo.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.contact.relationshipextensiblePatientContactRelationship
Patient.contact.genderrequiredAdministrativeGender
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorPatient.telecomA system is required if a value is provided.
: value.empty() or system.exists()
dom-r4bwarningPatient.containedContaining new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
: ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ide-1errorPatient.identifierThe Resource must have at least one Oficial Identifier
:
pat-1errorPatient.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()

 

Other representations of profile: CSV, Excel, Schematron