Taiwan Digital COVID Certificate - Local Development build (v0.0.1). See the Directory of published versions
Resource Profile: MyPatientName
| Defining URL: | https://ghit42796.github.io/fhir_test/index.html/StructureDefinition/zmypatient |
| Version: | 0.0.1 |
| Name: | MyPatientName |
| Title: | My Favorite Patient Profile |
| Status: | Draft as of 2021-04-16 |
| Definition: | This will be the description for the patient profile within the profile page |
| Publisher: | TBD |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
https://ghit42796.github.io/fhir_test/index.html/StructureDefinition/zmypatient
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Patient
This structure is derived from Patient
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Patient | 0..* | Patient | My Favorite Patient Profile | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | Patient | My Favorite Patient Profile | |
  id | Σ | 0..1 | string | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | An identifier for this patient |
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
| name | Σ | 0..* | HumanName | A name associated with the patient |
| telecom | Σ | 0..* | ContactPoint | A contact detail for the individual |
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
| birthDate | Σ | 0..1 | date | The date of birth for the individual |
  deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
 deceasedBoolean | boolean | |||
 deceasedDateTime | dateTime | |||
| address | Σ | 0..* | Address | An address for the individual |
| maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |
| multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||
| multipleBirthBoolean | boolean | |||
| multipleBirthInteger | integer | |||
| photo | 0..* | Attachment | Image of the patient | |
| contact | I | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| relationship | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |
| name | 0..1 | HumanName | A name associated with the contact person | |
| telecom | 0..* | ContactPoint | A contact detail for the person | |
| address | 0..1 | Address | Address for the contact person | |
| gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |
 organization | I | 0..1 | Reference(Organization) | Organization that is associated with the contact |
| period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |
| communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| preferred | 0..1 | boolean | Language preference indicator | |
| generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |
| managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record |
 link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | Patient | My Favorite Patient Profile | |
| Documentation for this format | ||||
This structure is derived from Patient
Differential View
This structure is derived from Patient
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | Patient | My Favorite Patient Profile | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | Patient | My Favorite Patient Profile | |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | An identifier for this patient |
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
| name | Σ | 0..* | HumanName | A name associated with the patient |
| telecom | Σ | 0..* | ContactPoint | A contact detail for the individual |
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
| birthDate | Σ | 0..1 | date | The date of birth for the individual |
| deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
| deceasedBoolean | boolean | |||
| deceasedDateTime | dateTime | |||
| address | Σ | 0..* | Address | An address for the individual |
| maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |
| multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||
| multipleBirthBoolean | boolean | |||
| multipleBirthInteger | integer | |||
| photo | 0..* | Attachment | Image of the patient | |
| contact | I | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| relationship | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |
| name | 0..1 | HumanName | A name associated with the contact person | |
| telecom | 0..* | ContactPoint | A contact detail for the person | |
| address | 0..1 | Address | Address for the contact person | |
| gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |
| organization | I | 0..1 | Reference(Organization) | Organization that is associated with the contact |
| period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |
| communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| preferred | 0..1 | boolean | Language preference indicator | |
| generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |
| managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record |
| link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
Terminology Bindings
| Path | Conformance | ValueSet |
| Patient.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Patient.gender | required | AdministrativeGender |
| Patient.maritalStatus | extensible | Marital Status Codes |
| Patient.contact.relationship | extensible | PatientContactRelationship |
| Patient.contact.gender | required | AdministrativeGender |
| Patient.communication.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Patient.link.type | required | LinkType |
Constraints
| Id | Path | Details | Requirements |
| dom-2 | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | Patient.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.active | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.gender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.birthDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.deceased[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.maritalStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.multipleBirth[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.photo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.contact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| pat-1 | Patient.contact | 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() | |
| ele-1 | Patient.contact.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.contact.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.contact.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.contact.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.contact.relationship | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.contact.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.contact.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.contact.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.contact.gender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.contact.organization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.contact.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.communication | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.communication.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.communication.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.communication.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.communication.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.communication.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.communication.preferred | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.generalPractitioner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.managingOrganization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.link | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.link.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.link.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.link.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.link.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.link.other | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.link.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |